pwspy.utility.acquisition.TimeStep

class pwspy.utility.acquisition.TimeStep(*args, **kwargs)[source]

Bases: pwspy.utility.acquisition.steps.IterableSequencerStep

getCoordinate()

Returns a sequencer coordinate range that points to this steps location in the tree of steps.

Return type

SequencerCoordinateRange

getIterationName(iteration)[source]

Return the name associated with iteration E.G. for a multiple-positions step this will be the name assigned to the position in the position list. :type iteration: int :param iteration: The iteeration number we are interested in.

Returns: A name for the requested iteration.

Return type

str

getTreePath()

Return a list of steps starting with the root step and ending with this step.

Return type

Tuple[TreeItem]

static hook(dct)

This method defines how the JSON library should translate from JSON to one of these objects. :type dct: dict :param dct: The dict representing the raw representation of the JSON

iterateChildren()

Recursively iterate through all children of this step

printSubTree(_indent=0)

Print out this step and all sub-steps in a human-readable format.

Return type

None

row()

Return which row we are with respect to the parent.

Return type

int

stepIterations()[source]

Return the total number of iterations of this step.