Package uk.ac.diamond.daq.scanning

Class FrameCollectingScannable

java.lang.Object
org.eclipse.scanning.api.AbstractNameable
org.eclipse.scanning.api.AbstractNameableTimeoutable
org.eclipse.scanning.api.AbstractScannable<Object>
uk.ac.diamond.daq.scanning.FrameCollectingScannable
All Implemented Interfaces:
Configurable, INexusDevice<NXdetector>, IActivatable, IBoundable<Object>, ILevel, INameable, IScanAttributeContainer, IScannable<Object>, ITimeoutable, ITolerable<Object>, IPositionListenable
Direct Known Subclasses:
CalibrationFrameCollector
public class FrameCollectingScannable extends AbstractScannable<Object> implements INexusDevice<NXdetector>, Configurable
When included in a scan, this pseudoscannable will configure the beamline as instructed by the beamlineConfiguration map, perform an AcquireRequest (i.e. capture a single frame), then restore the beamline to its previous configuration.
The snapshot is then linked to from the overall NeXus file under /entry/instrument/ as an NXdetector. The detector parameters for the frame collection are specified via a FrameRequestDocument which must be set in advance.

  • Constructor Details

    • FrameCollectingScannable

      public FrameCollectingScannable()

  • Method Details

    • configureAndCollect

      public void configureAndCollect(ScanModel scanModel) throws ScanningException
      This is invoked shortly before the main scan is configured
      Throws:
      ScanningException

    • setFrameRequestDocument

      public void setFrameRequestDocument(FrameRequestDocument frameRequestDocument)
      This must be set prior before the frame is collected. If this is to be a Malcolm scan, malcolmDetectorName must also be set (the name of the real detector wrapped in the Malcolm scan).

    • getNexusProvider

      public NexusObjectProvider<NXdetector> getNexusProvider(NexusScanInfo info) throws NexusException
      Description copied from interface: INexusDevice
      Returns the object provider required for writing correct NeXus files.

      In this method you should prepare the LazyDatasets the device will fill during the scan. You can also write out static device metadata, which will not change during the scan.

      Use the methods on NexusNodeFactory to create a NeXus object which matches the device e.g. a NXdetector. final NXdetector detector = NexusNodeFactory.createNXdetector();

      On the detector object you can create LazyDatasets and keep references which you can later use during the scan to write data. e.g. imageData = detector.initializeLazyDataset(NXdetector.NX_DATA, info.getRank() + 2, Double.class); You should also set chunking on the LazyDatasets you create e.g. imageData.setChunking(info.createChunk(detectorXSize, detectorYSize));.

      In this method you can also write static metadata such as the detector exposure e.g. detector.setField("exposure_time", model.getExposure());. Or static datasets such as the image axis data detector.setDataset("image_x_axis", DatasetFactory.createLinearSpace(DoubleDataset.class, minX, maxX, xPoints)); For fields that are defined in the NXDL base class definition for the returned nexus object, a setXXX or setXXXScalar method may be used as appropriate, e.g. detector.setLocalName(DatasetFactory.createFromObject("my detector")); or detector.setLocalNameScalar("my detector");

      If this device is a 'metadata scannable', then the device should write its data at this point directly into the returned nexus object. This can be done with the NXobject.setField(String, Object) method, or the setXXXScalar methods for fields defined in the appropriate NXDL base class definition.

      The default implementation of this method throws UnsupportedOperationException. One of either this method or INexusDevice.getNexusProviders(NexusScanInfo) must be overridden to create and return the nexus object(s) for this INexusDevice.

      Specified by:
      getNexusProvider in interface INexusDevice<NXdetector>
      Parameters:
      info - information about the scan which can be useful when creating datasets e.g. info.getRank()
      Returns:
      The NXobject created using the nodeFactory to represent this device
      Throws:
      NexusException - if the nexus object could not be created for any reason

    • setBeamlineConfiguration

      public void setBeamlineConfiguration(Map<String,Object> beamlineConfiguration)
      A map describing the beamline configuration required for the frame collection. The previous configuration will be restored after the frame is collected. May be empty if no particular configuration is required (but not null).

    • setNexusFieldName

      public void setNexusFieldName(String nexusFieldName)
      Name by which the frame data is linked in the main Nexus file

    • getMalcolmDetectorName

      protected String getMalcolmDetectorName(IRunnableDevice<? extends IDetectorModel> detector)

    • setMalcolmDetectorNames

      public void setMalcolmDetectorNames(Map<String,String> malcolmDetectorNames)

    • setUseDetectorTable

      public void setUseDetectorTable(boolean useDetectorTable)

    • configure

      public void configure() throws FactoryException
      Description copied from interface: Configurable
      Perform operations that must be done after Spring initialisation i.e. anything that goes beyond setting member variables.
      Specified by:
      configure in interface Configurable
      Throws:
      FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

    • reconfigure

      public void reconfigure() throws FactoryException
      Description copied from interface: Configurable
      Re-initialisation of values and states.

      Moved from Reconfigurable which has been deleted

      Specified by:
      reconfigure in interface Configurable
      Throws:
      FactoryException

    • isConfigured

      public boolean isConfigured()
      Description copied from interface: Configurable
      Checks to see if the object is already configured.
      Specified by:
      isConfigured in interface Configurable
      Returns:
      return true if configured false otherwise

    • isConfigureAtStartup

      public boolean isConfigureAtStartup()
      Description copied from interface: Configurable
      Indicates whether this object should be configured at startup.

      Moved from ConditionallyConfigurable which has been deleted

      Specified by:
      isConfigureAtStartup in interface Configurable

    • getPosition

      public Object getPosition() throws ScanningException
      Description copied from interface: IBoundable
      The position is the value which should be: 1. Greater than or equal to the lower 2. Less than or equal to the upper. 3. One of the permitted values, if they are not null.
      Specified by:
      getPosition in interface IBoundable<Object>
      Returns:
      Throws:
      ScanningException - if the position cannot be read for any reason

    • setPosition

      public Object setPosition(Object value, IPosition position) throws ScanningException
      Description copied from interface: IScannable
      Moves to the position required, blocking until it is complete. Similar to moveTo(...) in GDA8
      Specified by:
      setPosition in interface IScannable<Object>
      Parameters:
      value - that this scalar should take.
      position - if within in a scan or null if not within a scan.
      Returns:
      the new position attained by the device, if known. (Saves additional call to getPosition()) If not know the demand value is returned. NOTE if null is returned the system will call getPosition() again.
      Throws:
      ScanningException

    • abort

      public void abort() throws ScanningException, InterruptedException
      Description copied from interface: IScannable
      Call to terminate a movement before it is complete, for example when ScannablePositioner#abort is called due to an exception with another IScannable's movement
      Specified by:
      abort in interface IScannable<Object>
      Throws:
      ScanningException
      InterruptedException