pyxc.transform.transform_base

Module Contents

Classes

TransformationBase
MatrixTransformationBase	A base class for matrix transformations. It provides the basic functionality for matrix transformations.
ParametricTransformationBase

class pyxc.transform.transform_base.TransformationBase(parent: TransformationBase | None = None, *args, **kwargs)

set_parent(parent: Type[TransformationBase])

reset_parent()

abstract apply_transformation(x, y)

abstract apply_reverse_transformation(x, y)

class pyxc.transform.transform_base.MatrixTransformationBase(transformation_matrix: numpy.ndarray | None = None, parent: TransformationBase | None = None)

Bases: TransformationBase

A base class for matrix transformations. It provides the basic functionality for matrix transformations.

Parameters:

transformation_matrixnp.ndarray, optional

The transformation matrix to be used for transformation.

parentTransformationBase, optional

The parent transformation object.

Attributes:

externally_set_transformation_matrixnp.ndarray

transformation_matrixnp.ndarray

reverse_transformation_matrixnp.ndarray

parent_transformation_matrixnp.ndarray

property externally_set_transformation_matrix

property transformation_matrix

property reverse_transformation_matrix

Return a compiled reverse transformation matrix.

property parent_transformation_matrix

Return the base transformation matrix if set.

reset_queue()

apply_transformation(x, y)

class pyxc.transform.transform_base.ParametricTransformationBase(parent: TransformationBase | None = None, *args, **kwargs)

Bases: TransformationBase