lsst.afw.geom.python.transform Namespace Reference

Functions
def	getJacobian (self, x)
def	then (self, next, simplify=True)
def	unpickleTransform (cls, state)
def	reduceTransform (transform)
def	addTransformMethods (cls)

Variables
dictionary	transformRegistry = {}
	toEndpoint
	getJacobian
	then

Function Documentation

addTransformMethods()

def lsst.afw.geom.python.transform.addTransformMethods

(

cls

)

Add pure python methods to the specified Transform class, and register
the class in `transformRegistry`

All :ref:`_pybind11_transform_classes` must call this function.

Parameters
----------
cls : :ref:`_pybind11_transform_classes`
A Transform class or subclass, e.g.
`lsst.afw.geom.TransformPoint2ToSpherePoint`

Definition at line 94 of file transform.py.

def addTransformMethods(cls):
    """Add pure python methods to the specified Transform class, and register
    the class in `transformRegistry`
 
    All :ref:`_pybind11_transform_classes` must call this function.
 
    Parameters
    ----------
    cls : :ref:`_pybind11_transform_classes`
    A Transform class or subclass, e.g.
    `lsst.afw.geom.TransformPoint2ToSpherePoint`
    """
    global transformRegistry
    className = cls.__name__
    if className in transformRegistry:
        raise RuntimeError(f"Class {className!r}={transformRegistry[className]} already registered; "
                           f"cannot register class {cls}")
    transformRegistry[cls.__name__] = cls
    cls.getJacobian = getJacobian
    cls.then = then
    cls.__reduce__ = reduceTransform

getJacobian()

def lsst.afw.geom.python.transform.getJacobian	(		self,
			x
	)

Definition at line 47 of file transform.py.

def getJacobian(self, x):
    # Force 2D matrix over numpy's protests
    matrix = self._getJacobian(x)
    matrix.shape = (self.toEndpoint.nAxes,
                    self.fromEndpoint.nAxes)
    return matrix
 
 

reduceTransform()

def lsst.afw.geom.python.transform.reduceTransform

(

transform

)

Pickle a Transform object

This provides the `__reduce__` implementation for a Transform.

Definition at line 86 of file transform.py.

def reduceTransform(transform):
    """Pickle a Transform object
 
    This provides the `__reduce__` implementation for a Transform.
    """
    return unpickleTransform, (type(transform), transform.writeString())
 
 

then()

def lsst.afw.geom.python.transform.then	(		self,
			next,
			simplify = True
	)

Concatenate two transforms

The result of A.then(B) is is C(x) = B(A(x))

Definition at line 55 of file transform.py.

def then(self, next, simplify=True):
    """Concatenate two transforms
 
    The result of A.then(B) is is C(x) = B(A(x))
    """
    if self.toEndpoint == next.fromEndpoint:
        return self._then(next, simplify=simplify)
    else:
        raise lsst.pex.exceptions.InvalidParameterError(
            "Cannot concatenate %r and %r: endpoints do not match."
            % (self, next))
 
 

unpickleTransform()

def lsst.afw.geom.python.transform.unpickleTransform	(		cls,
			state
	)

Unpickle a Transform object

Parameters
----------
cls : `type`
    A `Transform` class.
state : `str`
    Pickled state.

Returns
-------
transform : `cls`
    The unpickled Transform.

Definition at line 68 of file transform.py.

def unpickleTransform(cls, state):
    """Unpickle a Transform object
 
    Parameters
    ----------
    cls : `type`
        A `Transform` class.
    state : `str`
        Pickled state.
 
    Returns
    -------
    transform : `cls`
        The unpickled Transform.
    """
    return cls.readString(state)
 
 

Variable Documentation

getJacobian

lsst.afw.geom.python.transform.getJacobian

Definition at line 112 of file transform.py.

then

lsst.afw.geom.python.transform.then

Definition at line 113 of file transform.py.

toEndpoint

lsst.afw.geom.python.transform.toEndpoint

Definition at line 60 of file transform.py.

transformRegistry

dictionary lsst.afw.geom.python.transform.transformRegistry = {}

Definition at line 44 of file transform.py.