npxpy.nodes.misc.StageMove

Bases: Node

A class to represent a stage move node with a specified stage position.

Attributes:

Name	Type	Description
target_position	List[float]	The target position of the stage [x, y, z].

Source code in npxpy/nodes/misc.py

class StageMove(Node):
    """
    A class to represent a stage move node with a specified stage position.

    Attributes:
        target_position (List[float]): The target position of the stage [x, y, z].
    """

    def __init__(
        self,
        name: str = "Stage move",
        stage_position: List[float] = [0.0, 0.0, 0.0],
    ):
        """
        Initialize the stage move node.

        Parameters:
            name (str): Name of the stage move node.
            stage_position (List[float]): Target position of the stage [x, y, z].
        """
        super().__init__(node_type="stage_move", name=name)
        self.stage_position = stage_position

    @property
    def stage_position(self):
        """Get the stage position."""
        return self._stage_position

    @stage_position.setter
    def stage_position(self, value: List[float]):
        """
        Set the stage position.

        Parameters:
            value (List[float]): The target stage position [x, y, z].

        Raises:
            TypeError: If stage_position is not a list of three numbers.
        """
        if len(value) != 3 or not all(
            isinstance(val, (float, int)) for val in value
        ):
            raise TypeError("stage_position must be a list of three numbers.")
        self._stage_position = value

    def to_dict(self) -> Dict[str, Any]:
        """
        Convert the StageMove object into a dictionary.

        Returns:
            Dict[str, Any]: Dictionary representation of the object.
        """
        node_dict = super().to_dict()  # Get the basic dict from Node
        node_dict["target_position"] = self.stage_position
        return node_dict

stage_position property writable

Get the stage position.

__init__(name='Stage move', stage_position=[0.0, 0.0, 0.0])

Initialize the stage move node.

Parameters:

Name	Type	Description	Default
name	str	Name of the stage move node.	'Stage move'
stage_position	List[float]	Target position of the stage [x, y, z].	[0.0, 0.0, 0.0]

Source code in npxpy/nodes/misc.py

def __init__(
    self,
    name: str = "Stage move",
    stage_position: List[float] = [0.0, 0.0, 0.0],
):
    """
    Initialize the stage move node.

    Parameters:
        name (str): Name of the stage move node.
        stage_position (List[float]): Target position of the stage [x, y, z].
    """
    super().__init__(node_type="stage_move", name=name)
    self.stage_position = stage_position

to_dict()

Convert the StageMove object into a dictionary.

Returns:

Type	Description
Dict[str, Any]	Dict[str, Any]: Dictionary representation of the object.

Source code in npxpy/nodes/misc.py

def to_dict(self) -> Dict[str, Any]:
    """
    Convert the StageMove object into a dictionary.

    Returns:
        Dict[str, Any]: Dictionary representation of the object.
    """
    node_dict = super().to_dict()  # Get the basic dict from Node
    node_dict["target_position"] = self.stage_position
    return node_dict