CellInfo

class lsst.skymap.CellInfo(index, innerBBox, outerBBox, sequentialIndex, tractWcs)

Bases: object

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

See PatchInfo and TractInfo for more information.

Parameters:
index : lsst.skymap.Index2D

x,y index of a cell (a pair of ints)

innerBBox : lsst.geom.Box2I

Inner bounding box.

outerBBox : lsst.geom.Box2I

Outer bounding box.

sequentialIndex : int

Cell sequential index.

tractWcs : lsst.afw.geom.SkyWcs

Tract WCS object.

Attributes Summary

index Return cell index: a tuple of (x, y)
inner_bbox Get inner bounding box.
inner_sky_polygon
outer_bbox Get outer bounding box.
outer_sky_polygon
sequential_index Return cell sequential index.
wcs Return the associated tract wcs

Methods Summary

getIndex() Return cell index: a tuple of (x, y)
getInnerBBox() Get inner bounding box.
getInnerSkyPolygon([tractWcs]) Get the inner on-sky region.
getOuterBBox() Get outer bounding box.
getOuterSkyPolygon([tractWcs]) Get the outer on-sky region.
getSequentialIndex() Return cell sequential index.
getWcs() Return the associated tract wcs

Attributes Documentation

index

Return cell index: a tuple of (x, y)

Returns:
result : lsst.skymap.Index2D

Patch index (x, y).

inner_bbox

Get inner bounding box.

Returns:
bbox : lsst.geom.Box2I

The inner bounding Box.

inner_sky_polygon
outer_bbox

Get outer bounding box.

Returns:
bbox : lsst.geom.Box2I

The outer bounding Box.

outer_sky_polygon
sequential_index

Return cell sequential index.

Returns:
result : int

Sequential cell index.

wcs

Return the associated tract wcs

Returns:
wcs : lsst.afw.geom.SkyWcs

Tract WCS.

Methods Documentation

getIndex()

Return cell index: a tuple of (x, y)

Returns:
result : lsst.skymap.Index2D

Patch index (x, y).

getInnerBBox()

Get inner bounding box.

Returns:
bbox : lsst.geom.Box2I

The inner bounding Box.

getInnerSkyPolygon(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.

getOuterBBox()

Get outer bounding box.

Returns:
bbox : lsst.geom.Box2I

The outer bounding Box.

getOuterSkyPolygon(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.

getSequentialIndex()

Return cell sequential index.

Returns:
result : int

Sequential cell index.

getWcs()

Return the associated tract wcs

Returns:
wcs : lsst.afw.geom.SkyWcs

Tract WCS.