Package org.eclipse.scanning.points

Interface PPointGenerator

All Superinterfaces:
Iterable<IPosition>, PySerializable
public interface PPointGenerator extends Iterable<IPosition>, PySerializable
Interface for [Jython] CompoundGenerator, itself wrapped by [Java] IPointGenerator. Additionally passes information about shape/rank/size/dimensions of the scan from the [Jython] generator. Note: This class is an implementation class and should not be used outside the scanning framework

  • Method Details

    • getSize

      int getSize()
      Returns:
      the number of points iterated over by this iterator.

    • getShape

      int[] getShape()
      Returns:
      the shape of the points iterated over by this iterator as an int array In some cases multiple dimensions will be squashed into a single dimension, for example when the inner most scan is a grid scan within a circular region.

    • getRank

      int getRank()
      Returns:
      the rank of the points iterated over by this iterator. In some cases dimensions may be flattened out, for example when the inner most scan is a grid scan within a circular region.

    • getNames

      List<String> getNames()
      Returns:
      list of names of the scannable axes that this generator includes

    • getFinalBounds

      IPosition getFinalBounds()
      Returns:
      The final Bound (half step beyond the final Point) of the underlying Python Generator. Used for ConsecutiveMultiModels

    • getInitialBounds

      IPosition getInitialBounds()
      Returns:
      The initial Bound (half step before the first Point) of the underlying Python Generator. Used for ConsecutiveMultiModels

    • getDimensionNames

      List<List<String>> getDimensionNames()