lsst.skymap g6075d09f38+9057f6c507
Public Member Functions | Properties | List of all members
lsst.skymap.patchInfo.PatchInfo Class Reference

Public Member Functions

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

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 : `Iterable` [`int`, `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__()

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

Definition at line 63 of file patchInfo.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 348 of file patchInfo.py.

◆ __getitem__()

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

Definition at line 345 of file patchInfo.py.

◆ __iter__()

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

Definition at line 335 of file patchInfo.py.

◆ __len__()

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

Definition at line 341 of file patchInfo.py.

◆ __ne__()

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

Definition at line 355 of file patchInfo.py.

◆ __repr__()

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

Definition at line 361 of file patchInfo.py.

◆ __str__()

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

Definition at line 358 of file patchInfo.py.

◆ getCellBorder()

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

Definition at line 202 of file patchInfo.py.

◆ getCellIndexPair()

def 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
    If index is out of range.

Definition at line 311 of file patchInfo.py.

◆ getCellInfo()

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

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

Definition at line 207 of file patchInfo.py.

◆ getCellInnerDimensions()

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

Definition at line 260 of file patchInfo.py.

◆ getIndex()

def 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 88 of file patchInfo.py.

◆ getInnerBBox()

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

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

Definition at line 124 of file patchInfo.py.

◆ getInnerSkyPolygon()

def 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 148 of file patchInfo.py.

◆ getNumCells()

def 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 188 of file patchInfo.py.

◆ getOuterBBox()

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

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

Definition at line 136 of file patchInfo.py.

◆ getOuterSkyPolygon()

def 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 168 of file patchInfo.py.

◆ getSequentialCellIndex()

def 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
    If index is out of range.

Definition at line 267 of file patchInfo.py.

◆ getSequentialCellIndexFromPair()

def 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
    If index is out of range.

Definition at line 287 of file patchInfo.py.

◆ getSequentialIndex()

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

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

Definition at line 100 of file patchInfo.py.

◆ getWcs()

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

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

Definition at line 112 of file patchInfo.py.

◆ inner_sky_polygon()

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

Definition at line 165 of file patchInfo.py.

◆ outer_sky_polygon()

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

Definition at line 185 of file patchInfo.py.

Property Documentation

◆ cell_border

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

Definition at line 205 of file patchInfo.py.

◆ cell_inner_dimensions

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

Definition at line 265 of file patchInfo.py.

◆ index

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

Definition at line 98 of file patchInfo.py.

◆ inner_bbox

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

Definition at line 134 of file patchInfo.py.

◆ num_cells

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

Definition at line 200 of file patchInfo.py.

◆ outer_bbox

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

Definition at line 146 of file patchInfo.py.

◆ sequential_index

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

Definition at line 110 of file patchInfo.py.

◆ wcs

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

Definition at line 122 of file patchInfo.py.


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