lsst.skymap.tractBuilder.CellTractBuilder Class Reference

Inheritance diagram for lsst.skymap.tractBuilder.CellTractBuilder:

Public Member Functions
	__init__ (self, config)
	getPatchInfo (self, index, tractWcs)
	getPackedConfig (self, config)

Static Public Attributes
	ConfigClass = CellTractBuilderConfig

Protected Attributes
	_cellInnerDimensions
	_cellBorder
	_numCellsPerPatchInner
	_numCellsInPatchBorder
	_patchInnerDimensions
	_patchBorder
	_initialized
	_tractBBox

Detailed Description

Definition at line 302 of file tractBuilder.py.

Constructor & Destructor Documentation

__init__()

lsst.skymap.tractBuilder.CellTractBuilder.__init__	(		self,
			config )

Reimplemented from lsst.skymap.tractBuilder.BaseTractBuilder.

Definition at line 305 of file tractBuilder.py.

    def __init__(self, config):
        super().__init__(config)
 
        self._cellInnerDimensions = geom.Extent2I(*(val
                                                    for val in config.cellInnerDimensions))
        self._cellBorder = config.cellBorder
        self._numCellsPerPatchInner = config.numCellsPerPatchInner
        self._numCellsInPatchBorder = config.numCellsInPatchBorder
        self._patchInnerDimensions = geom.Extent2I(*(val*self._numCellsPerPatchInner
                                                     for val in config.cellInnerDimensions))
        # The patch border is the number of cells in the border + the cell
        # border.
        self._patchBorder = config.numCellsInPatchBorder*config.cellInnerDimensions[0] + self._cellBorder
        self._initialized = False
 

Member Function Documentation

getPackedConfig()

lsst.skymap.tractBuilder.CellTractBuilder.getPackedConfig	(		self,
			config )

Get a packed config suitable for using in a sha1.

Parameters
----------
config : `lsst.skymap.BaseTractBuilderConfig`

Returns
-------
configPacked : `bytes`

Reimplemented from lsst.skymap.tractBuilder.BaseTractBuilder.

Definition at line 356 of file tractBuilder.py.

    def getPackedConfig(self, config):
        subConfig = config.tractBuilder[config.tractBuilder.name]
        configPacked = struct.pack(
            "<iiiiidd3sd",
            subConfig.cellInnerDimensions[0],
            subConfig.cellInnerDimensions[1],
            subConfig.cellBorder,
            subConfig.numCellsPerPatchInner,
            subConfig.numCellsInPatchBorder,
            config.tractOverlap,
            config.pixelScale,
            config.projection.encode('ascii'),
            config.rotation
        )
 
        return configPacked
 
 

getPatchInfo()

lsst.skymap.tractBuilder.CellTractBuilder.getPatchInfo	(		self,
			index,
			tractWcs )

Return information for the specified patch.

Parameters
----------
index : `lsst.skymap.Index2D` or `~collections.abc.Iterable` of 2 `int`
    Index of patch, as Index2D or pair of ints;
    or a sequential index as returned by getSequentialPatchIndex;
    negative values are not supported.
tractWcs : `lsst.afw.geom.SkyWcs`
    WCS associated with the tract.

Returns
-------
result : `lsst.skymap.PatchInfo`
    The patch info for that index.

Raises
------
IndexError
    Raised if index is out of range.

Reimplemented from lsst.skymap.tractBuilder.BaseTractBuilder.

Definition at line 320 of file tractBuilder.py.

    def getPatchInfo(self, index, tractWcs):
        # This should always be initialized
        if not self._initialized:
            raise RuntimeError("Programmer error; this should always be initialized.")
        if isinstance(index, Index2D):
            _index = index
        else:
            if isinstance(index, numbers.Number):
                _index = self.getPatchIndexPair(index)
            else:
                _index = Index2D(*index)
        if (not 0 <= _index.x < self._numPatches.x) \
           or (not 0 <= _index.y < self._numPatches.y):
            raise IndexError("Patch index %s is not in range [0-%d, 0-%d]" %
                             (_index, self._numPatches.x - 1, self._numPatches.y - 1))
        innerMin = geom.Point2I(*[_index[i]*self._patchInnerDimensions[i] for i in range(2)])
        innerBBox = geom.Box2I(innerMin, self._patchInnerDimensions)
        if not self._tractBBox.contains(innerBBox):
            raise RuntimeError(
                "Bug: patch index %s valid but inner bbox=%s not contained in tract bbox=%s" %
                (_index, innerBBox, self._tractBBox))
        outerBBox = geom.Box2I(innerBBox)
        outerBBox.grow(self.getPatchBorder())
        # We do not clip the patch for cell-based tracts.
        return PatchInfo(
            index=_index,
            innerBBox=innerBBox,
            outerBBox=outerBBox,
            sequentialIndex=self.getSequentialPatchIndexFromPair(_index),
            tractWcs=tractWcs,
            cellInnerDimensions=self._cellInnerDimensions,
            cellBorder=self._cellBorder,
            numCellsPerPatchInner=self._numCellsPerPatchInner,
            numCellsInPatchBorder=self._numCellsInPatchBorder
        )
 

Member Data Documentation

_cellBorder

lsst.skymap.tractBuilder.CellTractBuilder._cellBorder

protected

Definition at line 310 of file tractBuilder.py.

_cellInnerDimensions

lsst.skymap.tractBuilder.CellTractBuilder._cellInnerDimensions

protected

Definition at line 308 of file tractBuilder.py.

_initialized

lsst.skymap.tractBuilder.CellTractBuilder._initialized

protected

Definition at line 318 of file tractBuilder.py.

_numCellsInPatchBorder

lsst.skymap.tractBuilder.CellTractBuilder._numCellsInPatchBorder

protected

Definition at line 312 of file tractBuilder.py.

_numCellsPerPatchInner

lsst.skymap.tractBuilder.CellTractBuilder._numCellsPerPatchInner

protected

Definition at line 311 of file tractBuilder.py.

_patchBorder

lsst.skymap.tractBuilder.CellTractBuilder._patchBorder

protected

Definition at line 317 of file tractBuilder.py.

_patchInnerDimensions

lsst.skymap.tractBuilder.CellTractBuilder._patchInnerDimensions

protected

Definition at line 313 of file tractBuilder.py.

_tractBBox

lsst.skymap.tractBuilder.CellTractBuilder._tractBBox

protected

Definition at line 340 of file tractBuilder.py.

ConfigClass

lsst.skymap.tractBuilder.CellTractBuilder.ConfigClass = CellTractBuilderConfig

static

Definition at line 303 of file tractBuilder.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/skymap/ga8c6da7877+f1d96605c8/python/lsst/skymap/tractBuilder.py