lsst.skymap ga8c6da7877+a9c198e9fb
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Properties | List of all members
lsst.skymap.patchInfo.PatchInfo Class Reference

Public Member Functions

 __init__ (self, index, innerBBox, outerBBox, sequentialIndex, tractWcs, cellInnerDimensions=(0, 0), cellBorder=0, numCellsPerPatchInner=0, numCellsInPatchBorder=0)
 
 getIndex (self)
 
 getSequentialIndex (self)
 
 getWcs (self)
 
 getInnerBBox (self)
 
 getOuterBBox (self)
 
 getInnerSkyPolygon (self, tractWcs=None)
 
 inner_sky_polygon (self)
 
 getOuterSkyPolygon (self, tractWcs=None)
 
 outer_sky_polygon (self)
 
 getNumCells (self)
 
 getCellBorder (self)
 
 getCellInfo (self, index)
 
 getCellInnerDimensions (self)
 
 getSequentialCellIndex (self, cellInfo)
 
 getSequentialCellIndexFromPair (self, index)
 
 getCellIndexPair (self, sequentialIndex)
 
 __iter__ (self)
 
 __len__ (self)
 
 __getitem__ (self, index)
 
 __eq__ (self, rhs)
 
 __ne__ (self, rhs)
 
 __str__ (self)
 
 __repr__ (self)
 

Protected Attributes

 _index
 
 _sequentialIndex
 
 _innerBBox
 
 _outerBBox
 
 _wcs
 
 _cellInnerDimensions
 
 _cellBorder
 
 _numCellsInPatchBorder
 
 _numCells
 

Properties

 index = property(getIndex)
 
 sequential_index = property(getSequentialIndex)
 
 wcs = property(getWcs)
 
 inner_bbox = property(getInnerBBox)
 
 outer_bbox = property(getOuterBBox)
 
 num_cells = property(getNumCells)
 
 cell_border = property(getCellBorder)
 
 cell_inner_dimensions = property(getCellInnerDimensions)
 

Detailed Description

Information about a patch within a tract of a sky map.

If cellInnerDimensions and cellBorder are set then the patch
will be gridded with cells.

See `TractInfo` for more information.

Parameters
----------
index : `lsst.skymap.Index2D`
    x,y index of patch (a pair of ints)
innerBBox : `lsst.geom.Box2I`
    inner bounding box
outerBBox : `lsst.geom.Box2I`
    inner bounding box
sequentialIndex : `int`
    Patch sequential index
tractWcs : `lsst.afw.geom.SkyWcs`
    Tract WCS object.
cellInnerDimensions : `~collections.abc.Iterable` of 2 `int` or \
        `lsst.geom.Extent2I`, optional
    Inner dimensions of each cell (x,y pixels).
cellBorder : `int`, optional
    Cell border size (pixels).
numCellsPerPatchInner : `int`, optional
    Number of cells per inner patch region.
numCellsInPatchBorder : `int`, optional
    Number of cells in the patch border.

Definition at line 33 of file patchInfo.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.skymap.patchInfo.PatchInfo.__init__ ( self,
index,
innerBBox,
outerBBox,
sequentialIndex,
tractWcs,
cellInnerDimensions = (0, 0),
cellBorder = 0,
numCellsPerPatchInner = 0,
numCellsInPatchBorder = 0 )

Definition at line 64 of file patchInfo.py.

Member Function Documentation

◆ __eq__()

lsst.skymap.patchInfo.PatchInfo.__eq__ ( self,
rhs )

Definition at line 350 of file patchInfo.py.

◆ __getitem__()

lsst.skymap.patchInfo.PatchInfo.__getitem__ ( self,
index )

Definition at line 347 of file patchInfo.py.

◆ __iter__()

lsst.skymap.patchInfo.PatchInfo.__iter__ ( self)

Definition at line 337 of file patchInfo.py.

◆ __len__()

lsst.skymap.patchInfo.PatchInfo.__len__ ( self)

Definition at line 343 of file patchInfo.py.

◆ __ne__()

lsst.skymap.patchInfo.PatchInfo.__ne__ ( self,
rhs )

Definition at line 357 of file patchInfo.py.

◆ __repr__()

lsst.skymap.patchInfo.PatchInfo.__repr__ ( self)

Definition at line 363 of file patchInfo.py.

◆ __str__()

lsst.skymap.patchInfo.PatchInfo.__str__ ( self)

Definition at line 360 of file patchInfo.py.

◆ getCellBorder()

lsst.skymap.patchInfo.PatchInfo.getCellBorder ( self)

Definition at line 203 of file patchInfo.py.

◆ getCellIndexPair()

lsst.skymap.patchInfo.PatchInfo.getCellIndexPair ( self,
sequentialIndex )
Convert a sequential index into an index pair.

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

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

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

Definition at line 313 of file patchInfo.py.

◆ getCellInfo()

lsst.skymap.patchInfo.PatchInfo.getCellInfo ( self,
index )
Return information for the specified cell.

Parameters
----------
index : `lsst.skymap.Index2D` or `~collections.abc.Iterable` of 2 `int`
    Index of cell, as `Index2D` ,or two integers,
    or a sequential index as returned by getSequentialCellIndex;
    negative values are not supported.

Returns
-------
result : `lsst.skymap.CellInfo`
    The cell info for that index.

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

Definition at line 208 of file patchInfo.py.

◆ getCellInnerDimensions()

lsst.skymap.patchInfo.PatchInfo.getCellInnerDimensions ( self)
Get dimensions of inner region of the cells (all are the same)

Definition at line 262 of file patchInfo.py.

◆ getIndex()

lsst.skymap.patchInfo.PatchInfo.getIndex ( self)
Return patch index: a tuple of (x, y)

Returns
-------
result : `lsst.skymap.Index2D`
    Patch index (x, y).

Definition at line 89 of file patchInfo.py.

◆ getInnerBBox()

lsst.skymap.patchInfo.PatchInfo.getInnerBBox ( self)
Get inner bounding box.

Returns
-------
bbox : `lsst.geom.Box2I`
    The inner bounding Box.

Definition at line 125 of file patchInfo.py.

◆ getInnerSkyPolygon()

lsst.skymap.patchInfo.PatchInfo.getInnerSkyPolygon ( self,
tractWcs = None )
Get the inner on-sky region.

Parameters
----------
tractWcs : `lsst.afw.image.SkyWcs`, optional
    WCS for the associated tract.

Returns
-------
result : `lsst.sphgeom.ConvexPolygon`
    The inner sky region.

Definition at line 149 of file patchInfo.py.

◆ getNumCells()

lsst.skymap.patchInfo.PatchInfo.getNumCells ( self)
Get the number of cells in x, y.

May return (0, 0) if no cells are defined.

Returns
-------
result : `lsst.skymap.Index2D`
    The number of cells in x, y.

Definition at line 189 of file patchInfo.py.

◆ getOuterBBox()

lsst.skymap.patchInfo.PatchInfo.getOuterBBox ( self)
Get outer bounding box.

Returns
-------
bbox : `lsst.geom.Box2I`
    The outer bounding Box.

Definition at line 137 of file patchInfo.py.

◆ getOuterSkyPolygon()

lsst.skymap.patchInfo.PatchInfo.getOuterSkyPolygon ( self,
tractWcs = None )
Get the outer on-sky region.

Parameters
----------
tractWcs : `lsst.afw.image.SkyWcs`, optional
    WCS for the associated tract.

Returns
-------
result : `lsst.sphgeom.ConvexPolygon`
    The outer sky region.

Definition at line 169 of file patchInfo.py.

◆ getSequentialCellIndex()

lsst.skymap.patchInfo.PatchInfo.getSequentialCellIndex ( self,
cellInfo )
Return a single integer that uniquely identifies
the given cell within this patch.

Parameters
----------
cellInfo : `lsst.skymap.CellInfo`

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

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

Definition at line 269 of file patchInfo.py.

◆ getSequentialCellIndexFromPair()

lsst.skymap.patchInfo.PatchInfo.getSequentialCellIndexFromPair ( self,
index )
Return a single integer that uniquely identifies
the given cell within this patch.

Parameters
----------
index : `lsst.skymap.Index2D`

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

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

Definition at line 289 of file patchInfo.py.

◆ getSequentialIndex()

lsst.skymap.patchInfo.PatchInfo.getSequentialIndex ( self)
Return patch sequential index.

Returns
-------
result : `int`
    Sequential patch index.

Definition at line 101 of file patchInfo.py.

◆ getWcs()

lsst.skymap.patchInfo.PatchInfo.getWcs ( self)
Return the associated tract wcs

Returns
-------
wcs : `lsst.afw.geom.SkyWcs`
    Tract WCS.

Definition at line 113 of file patchInfo.py.

◆ inner_sky_polygon()

lsst.skymap.patchInfo.PatchInfo.inner_sky_polygon ( self)

Definition at line 166 of file patchInfo.py.

◆ outer_sky_polygon()

lsst.skymap.patchInfo.PatchInfo.outer_sky_polygon ( self)

Definition at line 186 of file patchInfo.py.

Member Data Documentation

◆ _cellBorder

lsst.skymap.patchInfo.PatchInfo._cellBorder
protected

Definition at line 80 of file patchInfo.py.

◆ _cellInnerDimensions

lsst.skymap.patchInfo.PatchInfo._cellInnerDimensions
protected

Definition at line 79 of file patchInfo.py.

◆ _index

lsst.skymap.patchInfo.PatchInfo._index
protected

Definition at line 68 of file patchInfo.py.

◆ _innerBBox

lsst.skymap.patchInfo.PatchInfo._innerBBox
protected

Definition at line 70 of file patchInfo.py.

◆ _numCells

lsst.skymap.patchInfo.PatchInfo._numCells
protected

Definition at line 83 of file patchInfo.py.

◆ _numCellsInPatchBorder

lsst.skymap.patchInfo.PatchInfo._numCellsInPatchBorder
protected

Definition at line 81 of file patchInfo.py.

◆ _outerBBox

lsst.skymap.patchInfo.PatchInfo._outerBBox
protected

Definition at line 71 of file patchInfo.py.

◆ _sequentialIndex

lsst.skymap.patchInfo.PatchInfo._sequentialIndex
protected

Definition at line 69 of file patchInfo.py.

◆ _wcs

lsst.skymap.patchInfo.PatchInfo._wcs
protected

Definition at line 72 of file patchInfo.py.

Property Documentation

◆ cell_border

lsst.skymap.patchInfo.PatchInfo.cell_border = property(getCellBorder)
static

Definition at line 206 of file patchInfo.py.

◆ cell_inner_dimensions

lsst.skymap.patchInfo.PatchInfo.cell_inner_dimensions = property(getCellInnerDimensions)
static

Definition at line 267 of file patchInfo.py.

◆ index

lsst.skymap.patchInfo.PatchInfo.index = property(getIndex)
static

Definition at line 99 of file patchInfo.py.

◆ inner_bbox

lsst.skymap.patchInfo.PatchInfo.inner_bbox = property(getInnerBBox)
static

Definition at line 135 of file patchInfo.py.

◆ num_cells

lsst.skymap.patchInfo.PatchInfo.num_cells = property(getNumCells)
static

Definition at line 201 of file patchInfo.py.

◆ outer_bbox

lsst.skymap.patchInfo.PatchInfo.outer_bbox = property(getOuterBBox)
static

Definition at line 147 of file patchInfo.py.

◆ sequential_index

lsst.skymap.patchInfo.PatchInfo.sequential_index = property(getSequentialIndex)
static

Definition at line 111 of file patchInfo.py.

◆ wcs

lsst.skymap.patchInfo.PatchInfo.wcs = property(getWcs)
static

Definition at line 123 of file patchInfo.py.


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