lsst.afw.cameraGeom._amplifier Namespace Reference

Classes
class	Amplifier
class	AmplifierGeometryComparison

Functions
	transform (self, *, outOffset=None, outFlipX=False, outFlipY=False)

Variables
dict	ReadoutCornerValNameDict
dict	ReadoutCornerNameValDict

Function Documentation

transform()

lsst.afw.cameraGeom._amplifier.transform	(		self,
		*	,
			outOffset = None,
			outFlipX = False,
			outFlipY = False )

Transform an amplifier builder (in-place) by applying shifts and
flips.

Parameters
----------
outOffset : `lsst.geom.Extent2I`, optional
    Post-transformation return value for ``self.getRawXYOffset()``.
    The default is ``(0, 0)``, which shifts the amplifier to its
    position in the assembled (but still untrimmed) raw image.
outFlipX : `bool`, optional
    Post-transformation return value for ``self.getRawFlipX()``.  The
    default is `False`, which flips the amplifier to its correct
    X orientation in the assembled raw image.
outFlipX : `bool`, optional
    Post-transformation return value for ``self.getRawFlipY()``.  The
    default is `False`, which flips the amplifier to its correct
    Y orientation in the assembled raw image.

Returns
-------
self : `AmplifierBuilder`
    Returned to enable method chaining, e.g.
    ``amplifier.rebuild().transform().finish()``.

Definition at line 132 of file _amplifier.py.

def transform(self, *, outOffset=None, outFlipX=False, outFlipY=False):
    """Transform an amplifier builder (in-place) by applying shifts and
    flips.
 
    Parameters
    ----------
    outOffset : `lsst.geom.Extent2I`, optional
        Post-transformation return value for ``self.getRawXYOffset()``.
        The default is ``(0, 0)``, which shifts the amplifier to its
        position in the assembled (but still untrimmed) raw image.
    outFlipX : `bool`, optional
        Post-transformation return value for ``self.getRawFlipX()``.  The
        default is `False`, which flips the amplifier to its correct
        X orientation in the assembled raw image.
    outFlipX : `bool`, optional
        Post-transformation return value for ``self.getRawFlipY()``.  The
        default is `False`, which flips the amplifier to its correct
        Y orientation in the assembled raw image.
 
    Returns
    -------
    self : `AmplifierBuilder`
        Returned to enable method chaining, e.g.
        ``amplifier.rebuild().transform().finish()``.
    """
    if outOffset is None:
        outOffset = Extent2I(0, 0)
    bbox = self.getRawBBox()
    awidth, aheight = bbox.getDimensions()
    #
    # Figure out how far flipping the amp LR and/or TB offsets the bboxes
    #
    boxMin0 = bbox.getMin()     # initial position of rawBBox's LLC corner
    if self.getRawFlipX() != outFlipX:
        bbox.flipLR(awidth)
    if self.getRawFlipY() != outFlipY:
        bbox.flipTB(aheight)
    shift = boxMin0 - bbox.getMin()
 
    for bboxName in ("",
                     "HorizontalOverscan",
                     "Data",
                     "VerticalOverscan",
                     "Prescan"):
        bbox = getattr(self, f"getRaw{bboxName}BBox")()
        if self.getRawFlipX() != outFlipX:
            bbox.flipLR(awidth)
        if self.getRawFlipY() != outFlipY:
            bbox.flipTB(aheight)
        bbox.shift(self.getRawXYOffset() + shift - outOffset)
 
        getattr(self, f"setRaw{bboxName}BBox")(bbox)
 
    # Update the Readout Corner if we've flipped anything.
    outReadoutCorner = self.getReadoutCorner()
    if self.getRawFlipX() != outFlipX:
        xFlipMapping = {ReadoutCorner.LL: ReadoutCorner.LR, ReadoutCorner.LR: ReadoutCorner.LL,
                        ReadoutCorner.UR: ReadoutCorner.UL, ReadoutCorner.UL: ReadoutCorner.UR}
        outReadoutCorner = xFlipMapping[outReadoutCorner]
    if self.getRawFlipY() != outFlipY:
        yFlipMapping = {ReadoutCorner.LL: ReadoutCorner.UL, ReadoutCorner.LR: ReadoutCorner.UR,
                        ReadoutCorner.UR: ReadoutCorner.LR, ReadoutCorner.UL: ReadoutCorner.LL}
        outReadoutCorner = yFlipMapping[outReadoutCorner]
    if outReadoutCorner != self.getReadoutCorner():
        self.setReadoutCorner(outReadoutCorner)
 
    #
    # All of these have now been transferred to the amp geometry
    #
    self.setRawXYOffset(outOffset)
    self.setRawFlipX(outFlipX)
    self.setRawFlipY(outFlipY)
    return self

Variable Documentation

ReadoutCornerNameValDict

dict lsst.afw.cameraGeom._amplifier.ReadoutCornerNameValDict

Initial value:

=  {val: key for key, val in
                            ReadoutCornerValNameDict.items()}

Definition at line 37 of file _amplifier.py.

ReadoutCornerValNameDict

dict lsst.afw.cameraGeom._amplifier.ReadoutCornerValNameDict

Initial value:

=  {
    ReadoutCorner.LL: "LL",
    ReadoutCorner.LR: "LR",
    ReadoutCorner.UR: "UR",
    ReadoutCorner.UL: "UL",
}

Definition at line 31 of file _amplifier.py.