Package org.eclipse.scanning.example.scannable

Class MockNeXusScannable

java.lang.Object
org.eclipse.scanning.api.AbstractNameable
org.eclipse.scanning.api.AbstractNameableTimeoutable
org.eclipse.scanning.api.AbstractScannable<Number>
org.eclipse.scanning.api.CountableScannable<Number>
org.eclipse.scanning.example.scannable.MockScannable
org.eclipse.scanning.example.scannable.MockNeXusScannable
All Implemented Interfaces:
INexusDevice<NXpositioner>, IActivatable, IBoundable<Number>, ILevel, INameable, IScanAttributeContainer, IScannable<Number>, ITerminatable, ITimeoutable, ITolerable<Number>, IPositionListenable
public class MockNeXusScannable extends MockScannable implements INexusDevice<NXpositioner>
A class to wrap any IScannable as a positioner and then write to a nexus file as the positions are set during the scan.

  • Field Details

  • Constructor Details

    • MockNeXusScannable

      public MockNeXusScannable()

    • MockNeXusScannable

      public MockNeXusScannable(String name, Number position, int level)

    • MockNeXusScannable

      public MockNeXusScannable(String name, Number position, int level, String unit)

  • Method Details

    • isWritingOn

      public boolean isWritingOn()

    • setWritingOn

      public void setWritingOn(boolean writingOn)

    • scanFinally

      public void scanFinally()

    • getNexusProvider

      public NexusObjectProvider<NXpositioner> 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<NXpositioner>
      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

    • setPosition

      public Number setPosition(Number 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<Number>
      Overrides:
      setPosition in class MockScannable
      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