lsst.skymap

The skymap package provides tools for creating pixelizations of the sky to define tracts and patches for imaging data.

A sky map describes a pixelization of image data that covers most or all of the sky. The imaging data is arranged as a sequence of overlapping rectangular “tracts”. Each tract is, in essence, a single large exposure. However, tracts are typically too large to fit into memory, so tracts are subdivided into rectangular, possibly overlapping “patches”. The patch size is chosen to easily fit into memory.

Contributing

lsst.skymap is developed at https://github.com/lsst/skymap. You can find Jira issues for this module under the skymap component.

Python API reference

lsst.skymap Package

Functions

makeSkyPolygonFromBBox(bbox, wcs)

Make an on-sky polygon from a bbox and a SkyWcs

Classes

BaseSkyMap([config])	A collection of overlapping Tracts that map part or all of the sky.
BaseSkyMapConfig(*args, **kw)
BaseTractBuilder(config)	Base class for algorithms that define patches within the tract.
BaseTractBuilderConfig(*args, **kw)	Configuration that is to be shared amongst all tract builders.
CellInfo(index, innerBBox, outerBBox, ...)	Information about a cell within a patch of a tract of a sky map.
CellTractBuilder(config)
CellTractBuilderConfig(*args, **kw)
DiscreteSkyMap(config[, version])	Discrete sky map pixelization.
DiscreteSkyMapConfig(*args, **kw)	Configuration for the DiscreteSkyMap
DodecaSkyMap([config])	Dodecahedron-based sky map pixelization.
DodecaSkyMapConfig(*args, **kw)
EquatSkyMap([config])	Equatorial sky map pixelization, e.g.
EquatSkyMapConfig(*args, **kw)
Index2D(x, y)	Two dimensional index for patches and cells.
LegacyTractBuilder(config)
LegacyTractBuilderConfig(*args, **kw)
PatchInfo(index, innerBBox, outerBBox, ...)	Information about a patch within a tract of a sky map.
TractInfo(id, tractBuilder, ctrCoord, ...)	Information about a tract in a SkyMap sky pixelization

lsst.skymap.detail Package

Functions

coordFromVec(vec[, defRA])	Convert an ICRS cartesian vector to an ICRS lsst.geom.SpherePoint
makeSkyPolygonFromBBox(bbox, wcs)	Make an on-sky polygon from a bbox and a SkyWcs

Classes

Dodecahedron([withFacesOnPoles])	A dodecahedron with positions of faces and associated vertices.
Index2D(x, y)	Two dimensional index for patches and cells.
WcsFactory(pixelScale, projection[, ...])	A factory for creating Wcs objects for the sky tiles.

Class Inheritance Diagram

digraph inheritancec94d185098 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Dodecahedron" [URL="../../../py-api/lsst.skymap.detail.Dodecahedron.html#lsst.skymap.detail.Dodecahedron",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A dodecahedron with positions of faces and associated vertices."]; "Index2D" [URL="../../../py-api/lsst.skymap.detail.Index2D.html#lsst.skymap.detail.Index2D",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Two dimensional index for patches and cells."]; "WcsFactory" [URL="../../../py-api/lsst.skymap.detail.WcsFactory.html#lsst.skymap.detail.WcsFactory",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A factory for creating Wcs objects for the sky tiles."]; }

lsst.skymap.cachingSkyMap Module

Classes

CachingSkyMap(numTracts[, config, version])

A SkyMap that generates its tracts on request and caches them.

Class Inheritance Diagram

digraph inheritancef71750c518 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseSkyMap" [URL="../../../py-api/lsst.skymap.BaseSkyMap.html#lsst.skymap.BaseSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A collection of overlapping Tracts that map part or all of the sky."]; "CachingSkyMap" [URL="../../../py-api/lsst.skymap.cachingSkyMap.CachingSkyMap.html#lsst.skymap.cachingSkyMap.CachingSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A SkyMap that generates its tracts on request and caches them."]; "BaseSkyMap" -> "CachingSkyMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.skymap.healpixSkyMap Module

Classes

HealpixSkyMapConfig(*args, **kw)	Configuration for the HealpixSkyMap
HealpixSkyMap(config[, version])	HEALPix-based sky map pixelization.

Class Inheritance Diagram

digraph inheritance58358b917c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseSkyMap" [URL="../../../py-api/lsst.skymap.BaseSkyMap.html#lsst.skymap.BaseSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A collection of overlapping Tracts that map part or all of the sky."]; "BaseSkyMapConfig" [URL="../../../py-api/lsst.skymap.BaseSkyMapConfig.html#lsst.skymap.BaseSkyMapConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Config" -> "BaseSkyMapConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CachingSkyMap" [URL="../../../py-api/lsst.skymap.cachingSkyMap.CachingSkyMap.html#lsst.skymap.cachingSkyMap.CachingSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A SkyMap that generates its tracts on request and caches them."]; "BaseSkyMap" -> "CachingSkyMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "HealpixSkyMap" [URL="../../../py-api/lsst.skymap.healpixSkyMap.HealpixSkyMap.html#lsst.skymap.healpixSkyMap.HealpixSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="HEALPix-based sky map pixelization."]; "CachingSkyMap" -> "HealpixSkyMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HealpixSkyMapConfig" [URL="../../../py-api/lsst.skymap.healpixSkyMap.HealpixSkyMapConfig.html#lsst.skymap.healpixSkyMap.HealpixSkyMapConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration for the HealpixSkyMap"]; "BaseSkyMapConfig" -> "HealpixSkyMapConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.skymap.ringsSkyMap Module

Classes

RingsSkyMapConfig(*args, **kw)	Configuration for the RingsSkyMap
RingsSkyMap(config[, version])	Rings sky map pixelization.

Class Inheritance Diagram

digraph inheritance277d3dc0bc { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseSkyMap" [URL="../../../py-api/lsst.skymap.BaseSkyMap.html#lsst.skymap.BaseSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A collection of overlapping Tracts that map part or all of the sky."]; "BaseSkyMapConfig" [URL="../../../py-api/lsst.skymap.BaseSkyMapConfig.html#lsst.skymap.BaseSkyMapConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Config" -> "BaseSkyMapConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CachingSkyMap" [URL="../../../py-api/lsst.skymap.cachingSkyMap.CachingSkyMap.html#lsst.skymap.cachingSkyMap.CachingSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A SkyMap that generates its tracts on request and caches them."]; "BaseSkyMap" -> "CachingSkyMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "RingsSkyMap" [URL="../../../py-api/lsst.skymap.ringsSkyMap.RingsSkyMap.html#lsst.skymap.ringsSkyMap.RingsSkyMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Rings sky map pixelization."]; "CachingSkyMap" -> "RingsSkyMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RingsSkyMapConfig" [URL="../../../py-api/lsst.skymap.ringsSkyMap.RingsSkyMapConfig.html#lsst.skymap.ringsSkyMap.RingsSkyMapConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration for the RingsSkyMap"]; "BaseSkyMapConfig" -> "RingsSkyMapConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; }