pwspy.utility.acquisition.SequencerStep

class pwspy.utility.acquisition.SequencerStep(id, settings, stepType, children=None)[source]

Bases: pwspy.utility.acquisition._treeItem.TreeItem

Implementation of a TreeItem for representing a sequencer step.

Parameters

  • id (int) – The unique integer assigned to this step by the acquisition software

  • settings (dict) – The settings for this step. Saved as JSON in the sequence file.

  • stepType (str) – Indicates what type of step this is. E.g. acquisition, time-series, focus lock, etc.

  • children (Optional[List[SequencerStep]]) – A list of steps which are direct children of this step.

getCoordinate()[source]

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

Return type

SequencerCoordinateRange

getTreePath()

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

Return type

Tuple[TreeItem]

static hook(dct)[source]

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)[source]

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