<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
  <compounddef id="indexpage" kind="page">
    <compoundname>index</compoundname>
    <title>lsst::skymap;  sky pixelization</title>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<sect1 id="index_1skyMap_introduction">
<title>Introduction</title>
<para>A sky map describes a pixelization of image data that covers most or all of the sky.</para>
<para>The imaging data is arranged as a sequence of overlapping rectangular &quot;tracts&quot;. 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 &quot;patches&quot;. The patch size is chosen to easily fit into memory.</para>
<para>Tracts contain an inner region described by a collection of vertices. The inner regions exactly tile the portion of sky covered by the sky map. All pixels beyond the inner region provide overlap with neighboring tracts.</para>
<para>Patches contain rectangular inner and outer regions. The inner regions exactly tile the tract, and all patches in a tract have the same inner dimensions. Each patch has a border around the inner region to provide some overlap with adjacent patches, but there is no border on patch edges that lie against tract boundaries.</para>
<para>Imaging data is saved as one FITS file per patch. To access a patch the butler requires the tract ID and patch index. <ref refid="classlsst_1_1skymap_1_1base_sky_map_1_1_base_sky_map_1a0a74d08c2694bd4b3e3f0c04b5283258" kindref="member">BaseSkyMap.findTract(coord)</ref> finds a tract and returns its <ref refid="classlsst_1_1skymap_1_1tract_info_1_1_tract_info" kindref="compound">TractInfo</ref>, given a <ref refid="namespacelsst_1_1afw_1_1table_1ada7dd01b862d142d92f347af70270102" kindref="member" external="/data1/kirg/hscpipe8/stack/miniconda3-py38_4.9.2-0.4.3/Linux64/afw/22.0.0+e73869a214/doc/afw.tag">coord</ref>. <ref refid="classlsst_1_1skymap_1_1tract_info_1_1_tract_info_1af4112c54fbf15d76ec23b902959d7a17" kindref="member">TractInfo.findPatch(coord)</ref> finds a patch and returns its <ref refid="classlsst_1_1skymap_1_1patch_info_1_1_patch_info" kindref="compound">PatchInfo</ref>.</para>
<para>Classes available from Python include:</para>
<para><itemizedlist>
<listitem><para><ref refid="classlsst_1_1skymap_1_1base_sky_map_1_1_base_sky_map" kindref="compound">BaseSkyMap</ref>: abstract base class for sky maps. Each subclass acts as an iterable collection of <ref refid="classlsst_1_1skymap_1_1tract_info_1_1_tract_info" kindref="compound">TractInfo</ref>.</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1dodeca_sky_map_1_1_dodeca_sky_map" kindref="compound">DodecaSkyMap</ref>: tracts are arranged as the faces of a dodecahedron covering the whole sky.</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1equat_sky_map_1_1_equat_sky_map" kindref="compound">EquatSkyMap</ref>: tracts are arranged in a band described by a declination range.</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1discrete_sky_map_1_1_discrete_sky_map" kindref="compound">DiscreteSkyMap</ref>: tracts are placed at explicitly defined positions (e.g., for deep fields).</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1rings_sky_map_1_1_rings_sky_map" kindref="compound">RingsSkyMap</ref>: square tracts are arranged in declination rings with polar caps.</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1healpix_sky_map_1_1_healpix_sky_map" kindref="compound">HealpixSkyMap</ref>: tracts are arranged as HEALPixels (requires the healpy package).</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1tract_info_1_1_tract_info" kindref="compound">TractInfo</ref>: information about a tract, including a bounding box, WCS, vertices describing the inner region, and a collection of <ref refid="classlsst_1_1skymap_1_1patch_info_1_1_patch_info" kindref="compound">PatchInfo</ref>.</para>
</listitem><listitem><para><ref refid="classlsst_1_1skymap_1_1patch_info_1_1_patch_info" kindref="compound">PatchInfo</ref>: information about a patch, including index, inner and outer bounding boxes. </para>
</listitem></itemizedlist>
</para>
</sect1>
    </detaileddescription>
    <location file="doc/main.dox"/>
  </compounddef>
</doxygen>
