Package org.eclipse.scanning.sequencer

Class SubscanModerator

java.lang.Object
org.eclipse.scanning.sequencer.SubscanModerator
public class SubscanModerator extends Object
This class takes a position iterator and it is a compound generator, attempts to remove the inner scans which subscan devices such as Malcolm will take care of from the compound generator and return the outer scans.

  • Constructor Details

  • Method Details

    • getScanModel

      public ScanModel getScanModel()

    • getOuterPointGenerator

      public IPointGenerator<?> getOuterPointGenerator()
      Returns the point generator for the outer points of the scan. The outer iterable will not be null normally. Even if all of the scan is deal with by malcolm the outer scan will still be a static generator of one point. If there are no subscan devices, then the outer scan is the full scan.
      Returns:
      an iterator over the outer scan

    • getInnerPointGenerator

      public IPointGenerator<?> getInnerPointGenerator()
      Returns the point generator for the over the inner points of the scan. For any scan that contains a malcolm device the inner point generator will not be null, even if all of the scan is dealt with outside the malcolm device. Note that this method is only used in dummy mode, for example by a DummyMalcolmDevice. The real malcolm device is passed the point generator for the whole scan. The malcolm device will itself determine what part of the scan it is responsible for (i.e. in python).
      Returns:
      an iterator over the inner scan

    • getOuterModels

      public List<IScanPointGeneratorModel> getOuterModels()

    • getInnerModels

      public List<IScanPointGeneratorModel> getInnerModels()

    • getInnerScanSize

      public int getInnerScanSize()

    • getOuterScanSize

      public int getOuterScanSize()

    • getTotalScanSize

      public int getTotalScanSize()