lsst.skymap g37c6e7c3d5+24a16624a8
|
Public Member Functions | |
getIntFromFilter (cls, name) | |
getFilterNameFromInt (cls, num) | |
getMaxIntForFilters (cls) | |
__init__ (self, DataCoordinate fixed, DimensionGraph|None dimensions=None, Mapping[str, int]|None bands=None, int|None n_bands=None, int|None n_tracts=None, int|None n_patches=None) | |
ConfigurableField | make_config_field (cls, str doc="How to pack tract, patch, and possibly band into an integer.") |
SkyMapDimensionPacker | from_config (cls, DataCoordinate data_id, SkyMapDimensionPackerConfig config) |
int | maxBits (self) |
DataCoordinate | unpack (self, int packedId) |
Public Attributes | |
SUPPORTED_FILTERS | |
Static Public Attributes | |
tuple | SUPPORTED_FILTERS |
ConfigClass = SkyMapDimensionPackerConfig | |
Protected Member Functions | |
int | _pack (self, DataCoordinate dataId) |
Protected Attributes | |
_bands | |
_n_bands | |
_n_tracts | |
_n_patches | |
_bands_list | |
A `DimensionPacker` for tract, patch and optionally band, given a SkyMap. Parameters ---------- fixed : `lsst.daf.butler.DataCoordinate` Data ID that identifies just the ``skymap`` dimension. Must have dimension records attached unless ``n_tracts`` and ``n_patches`` are not `None`. dimensions : `lsst.daf.butler.DimensionGraph`, optional The dimensions of data IDs packed by this instance. Must include ``{skymap, tract, patch}``, and may include ``band``. If not provided, this will be set to include ``band`` if ``n_bands != 0``. bands : `~collections.abc.Mapping` [ `str`, `int` ] or `None`, optional Mapping from band name to integer to use in the packed ID. `None` uses a fixed set of bands defined in this class. When calling code can enumerate the bands it is likely to see, providing an explicit mapping is preferable. n_bands : `int` or `None`, optional The number of bands to leave room for in the packed ID. If `None`, this will be set to ``len(bands)``. If ``0``, the band will not be included in the dimensions at all. If ``1``, the band will be included in the dimensions but will not occupy any extra bits in the packed ID. This may be larger or smaller than ``len(bands)``, to reserve extra space for the future or align to byte boundaries, or support a subset of a larger mapping, respectively. n_tracts : `int` or `None`, optional The number of tracts to leave room for in the packed ID. If `None`, this will be set via the ``skymap`` dimension record in ``fixed``. n_patches : `int` or `None`, optional The number of patches (per tract) to leave room for in the packed ID. If `None`, this will be set via the ``skymap`` dimension record in ``fixed``. Notes ----- The standard pattern for constructing instances of this class is to use `make_config_field`:: class SomeConfig(lsst.pex.config.Config): packer = ObservationDimensionPacker.make_config_field() class SomeTask(lsst.pipe.base.Task): ConfigClass = SomeConfig def run(self, ..., data_id: DataCoordinate): packer = self.config.packer.apply(data_id) packed_id = packer.pack(data_id) ...
Definition at line 68 of file packers.py.
lsst.skymap.packers.SkyMapDimensionPacker.__init__ | ( | self, | |
DataCoordinate | fixed, | ||
DimensionGraph | None | dimensions = None , |
||
Mapping[str, int] | None | bands = None , |
||
int | None | n_bands = None , |
||
int | None | n_tracts = None , |
||
int | None | n_patches = None |
||
) |
Definition at line 174 of file packers.py.
|
protected |
Definition at line 284 of file packers.py.
SkyMapDimensionPacker lsst.skymap.packers.SkyMapDimensionPacker.from_config | ( | cls, | |
DataCoordinate | data_id, | ||
SkyMapDimensionPackerConfig | config | ||
) |
Construct a dimension packer from a config object and a data ID. Parameters ---------- data_id : `lsst.daf.butler.DataCoordinate` Data ID that identifies at least the ``skymap`` dimension. Must have dimension records attached unless ``config.n_tracts`` and ``config.n_patches`` are both not `None`. config : `SkyMapDimensionPackerConfig` Configuration object. Returns ------- packer : `SkyMapDimensionPackerConfig` New dimension packer. Notes ----- This interface is provided for consistency with the `lsst.pex.config` "Configurable" concept, and is invoked when ``apply(data_id)`` is called on a config instance attribute that corresponds to a field created by `make_config_field`. The constructor signature cannot play this role easily for backwards compatibility reasons.
Definition at line 241 of file packers.py.
lsst.skymap.packers.SkyMapDimensionPacker.getFilterNameFromInt | ( | cls, | |
num | |||
) |
Return an band name from its integer representation.
Definition at line 160 of file packers.py.
lsst.skymap.packers.SkyMapDimensionPacker.getIntFromFilter | ( | cls, | |
name | |||
) |
Return an integer that represents the band with the given name.
Definition at line 144 of file packers.py.
lsst.skymap.packers.SkyMapDimensionPacker.getMaxIntForFilters | ( | cls | ) |
Definition at line 171 of file packers.py.
ConfigurableField lsst.skymap.packers.SkyMapDimensionPacker.make_config_field | ( | cls, | |
str | doc = "How to pack tract, patch, and possibly band into an integer." |
||
) |
Make a config field to control how skymap data IDs are packed. Parameters ---------- doc : `str`, optional Documentation for the config field. Returns ------- field : `lsst.pex.config.ConfigurableField` A config field whose instance values are [wrapper proxies to] `SkyMapDimensionPackerConfig` instances.
Definition at line 221 of file packers.py.
int lsst.skymap.packers.SkyMapDimensionPacker.maxBits | ( | self | ) |
Definition at line 277 of file packers.py.
DataCoordinate lsst.skymap.packers.SkyMapDimensionPacker.unpack | ( | self, | |
int | packedId | ||
) |
Definition at line 305 of file packers.py.
|
protected |
Definition at line 214 of file packers.py.
|
protected |
Definition at line 218 of file packers.py.
|
protected |
Definition at line 215 of file packers.py.
|
protected |
Definition at line 217 of file packers.py.
|
protected |
Definition at line 216 of file packers.py.
|
static |
Definition at line 135 of file packers.py.
|
static |
Definition at line 121 of file packers.py.
lsst.skymap.packers.SkyMapDimensionPacker.SUPPORTED_FILTERS |
Definition at line 172 of file packers.py.