lsst.skymap  22.0.1-6-g50866e6+303e5401d2
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.tractBuilder.CellTractBuilder Class Reference
Inheritance diagram for lsst.skymap.tractBuilder.CellTractBuilder:
lsst.skymap.tractBuilder.BaseTractBuilder

Public Member Functions

def __init__ (self, config)
 
def getPatchInfo (self, index, tractWcs)
 
def getPackedConfig (self, config)
 
def setupPatches (self, minBBox, wcs)
 
def getPatchBorder (self)
 
def getPatchInnerDimensions (self)
 
def getSequentialPatchIndex (self, patchInfo)
 
def getSequentialPatchIndexFromPair (self, index)
 
def getPatchIndexPair (self, sequentialIndex)
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = CellTractBuilderConfig
 

Detailed Description

Definition at line 300 of file tractBuilder.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from lsst.skymap.tractBuilder.BaseTractBuilder.

Definition at line 303 of file tractBuilder.py.

Member Function Documentation

◆ getPackedConfig()

def 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 353 of file tractBuilder.py.

◆ getPatchBorder()

def lsst.skymap.tractBuilder.BaseTractBuilder.getPatchBorder (   self)
inherited

Definition at line 94 of file tractBuilder.py.

◆ getPatchIndexPair()

def lsst.skymap.tractBuilder.BaseTractBuilder.getPatchIndexPair (   self,
  sequentialIndex 
)
inherited
Convert sequential index into patch index (x,y) pair.

Parameters
----------
sequentialIndex : `int`

Returns
-------
x, y : `lsst.skymap.Index2D`

Definition at line 165 of file tractBuilder.py.

◆ getPatchInfo()

def lsst.skymap.tractBuilder.CellTractBuilder.getPatchInfo (   self,
  index,
  tractWcs 
)
Return information for the specified patch.

Parameters
----------
index : `lsst.skymap.Index2D` or `Iterable` [`int`, `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
    If index is out of range.

Reimplemented from lsst.skymap.tractBuilder.BaseTractBuilder.

Definition at line 317 of file tractBuilder.py.

◆ getPatchInnerDimensions()

def lsst.skymap.tractBuilder.BaseTractBuilder.getPatchInnerDimensions (   self)
inherited
Get dimensions of inner region of the patches (all are the same)

Definition at line 122 of file tractBuilder.py.

◆ getSequentialPatchIndex()

def lsst.skymap.tractBuilder.BaseTractBuilder.getSequentialPatchIndex (   self,
  patchInfo 
)
inherited
Return a single integer that uniquely identifies
the given patch within this tract.

Parameters
----------
patchInfo : `lsst.skymap.PatchInfo`

Returns
-------
sequentialIndex : `int`

Definition at line 127 of file tractBuilder.py.

◆ getSequentialPatchIndexFromPair()

def lsst.skymap.tractBuilder.BaseTractBuilder.getSequentialPatchIndexFromPair (   self,
  index 
)
inherited
Return a single integer that uniquely identifies
the patch index within the tract.

Parameters
----------
index : `lsst.skymap.Index2D` or `Iterable` [`int`, `int`]

Returns
-------
sequentialIndex : `int`

Definition at line 142 of file tractBuilder.py.

◆ setupPatches()

def lsst.skymap.tractBuilder.BaseTractBuilder.setupPatches (   self,
  minBBox,
  wcs 
)
inherited
Set up the patches of a particular size in a tract.

We grow the tract bounding box to hold an exact multiple of
the desired size (patchInnerDimensions or
numCellsPerPatchInner*cellInnerDimensions), while keeping
the center roughly the same.  We return the final tract
bounding box, and the number of patches in each dimension
(as an Index2D).

Parameters
----------
minBBox : `lsst.geom.Box2I`
    Minimum bounding box for tract
wcs : `lsst.afw.geom.SkyWcs`
    Wcs object

Returns
-------
bbox : `lsst.geom.Box2I
    final bounding box, number of patches
numPatches : `lsst.skymap.Index2D`

Definition at line 51 of file tractBuilder.py.

Member Data Documentation

◆ config

lsst.skymap.tractBuilder.BaseTractBuilder.config
inherited

Definition at line 49 of file tractBuilder.py.

◆ ConfigClass

lsst.skymap.tractBuilder.CellTractBuilder.ConfigClass = CellTractBuilderConfig
static

Definition at line 301 of file tractBuilder.py.


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