lsst.afw.geom.testUtils.PermutedFrameSet Class Reference

Public Member Functions
	__init__ (self, frameSet, permuteBase, permuteCurr)

Public Attributes
	frameSet
	isBaseSkyFrame
	isCurrSkyFrame
	isBasePermuted
	isCurrPermuted

Detailed Description

A FrameSet with base or current frame possibly permuted, with associated
information

Only two-axis frames will be permuted.

Parameters
----------
frameSet : `ast.FrameSet`
    The FrameSet you wish to permute. A deep copy is made.
permuteBase : `bool`
    Permute the base frame's axes?
permuteCurr : `bool`
    Permute the current frame's axes?

Raises
------
RuntimeError
    If you try to permute a frame that does not have 2 axes

Notes
-----
**Fields**

frameSet : `ast.FrameSet`
    The FrameSet that may be permuted. A local copy is made.
isBaseSkyFrame : `bool`
    Is the base frame an `ast.SkyFrame`?
isCurrSkyFrame : `bool`
    Is the current frame an `ast.SkyFrame`?
isBasePermuted : `bool`
    Are the base frame axes permuted?
isCurrPermuted : `bool`
    Are the current frame axes permuted?

Definition at line 273 of file testUtils.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.geom.testUtils.PermutedFrameSet.__init__	(		self,
			frameSet,
			permuteBase,
			permuteCurr )

Definition at line 308 of file testUtils.py.

    def __init__(self, frameSet, permuteBase, permuteCurr):
        self.frameSet = frameSet.copy()
        fsInfo = FrameSetInfo(self.frameSet)
        self.isBaseSkyFrame = fsInfo.isBaseSkyFrame
        self.isCurrSkyFrame = fsInfo.isCurrSkyFrame
        if permuteBase:
            baseNAxes = self.frameSet.getFrame(fsInfo.baseInd).nAxes
            if baseNAxes != 2:
                raise RuntimeError("Base frame has {} axes; 2 required to permute".format(baseNAxes))
            self.frameSet.current = fsInfo.baseInd
            self.frameSet.permAxes([2, 1])
            self.frameSet.current = fsInfo.currInd
        if permuteCurr:
            currNAxes = self.frameSet.getFrame(fsInfo.currInd).nAxes
            if currNAxes != 2:
                raise RuntimeError("Current frame has {} axes; 2 required to permute".format(currNAxes))
            assert self.frameSet.getFrame(fsInfo.currInd).nAxes == 2
            self.frameSet.permAxes([2, 1])
        self.isBasePermuted = permuteBase
        self.isCurrPermuted = permuteCurr
 
 

Member Data Documentation

frameSet

lsst.afw.geom.testUtils.PermutedFrameSet.frameSet

Definition at line 309 of file testUtils.py.

isBasePermuted

lsst.afw.geom.testUtils.PermutedFrameSet.isBasePermuted

Definition at line 326 of file testUtils.py.

isBaseSkyFrame

lsst.afw.geom.testUtils.PermutedFrameSet.isBaseSkyFrame

Definition at line 311 of file testUtils.py.

isCurrPermuted

lsst.afw.geom.testUtils.PermutedFrameSet.isCurrPermuted

Definition at line 327 of file testUtils.py.

isCurrSkyFrame

lsst.afw.geom.testUtils.PermutedFrameSet.isCurrSkyFrame

Definition at line 312 of file testUtils.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/python/lsst/afw/geom/testUtils.py