lsst.skymap.packers.SkyMapDimensionPacker Class Reference

Inheritance diagram for lsst.skymap.packers.SkyMapDimensionPacker:

Public Member Functions
def	getIntFromFilter (cls, name)
def	getFilterNameFromInt (cls, num)
def	getMaxIntForFilters (cls)
def	configure (cls, dimensions)
def	__init__ (self, DataCoordinate fixed, DimensionGraph dimensions)
int	maxBits (self)
DataCoordinate	unpack (self, int packedId)

Static Public Attributes
tuple	SUPPORTED_FILTERS

Detailed Description

A `DimensionPacker` for tract, patch and optionally band,
given a SkyMap.

Parameters
----------
fixed : `lsst.daf.butler.DataCoordinate`
    Expanded data ID that must include at least the skymap dimension.
dimensions : `lsst.daf.butler.DimensionGraph`
    The dimensions of data IDs packed by this instance.  Must include
    skymap, tract, and patch, and may include band.

Definition at line 27 of file packers.py.

Constructor & Destructor Documentation

__init__()

def lsst.skymap.packers.SkyMapDimensionPacker.__init__	(		self,
		DataCoordinate	fixed,
		DimensionGraph	dimensions
	)

Definition at line 80 of file packers.py.

    def __init__(self, fixed: DataCoordinate, dimensions: DimensionGraph):
        super().__init__(fixed, dimensions)
        record = fixed.records["skymap"]
        self._skyMapName = record.name
        self._patchMax = record.patch_nx_max * record.patch_ny_max
        self._tractPatchMax = self._patchMax*record.tract_max
        if "band" in dimensions:
            self._filterMax = self.getMaxIntForFilters()
        else:
            self._filterMax = None
 

Member Function Documentation

configure()

def lsst.skymap.packers.SkyMapDimensionPacker.configure	(		cls,
			dimensions
	)

Definition at line 72 of file packers.py.

    def configure(cls, dimensions):
        # Docstring inherited from DataIdPacker.configure
        assert dimensions.given == ["skymap"]
        assert dimensions.required.issuperset(["tract", "patch"])
        metadata = {"skymap": ["tract_max", "patch_nx_max", "patch_ny_max"]}
        kwds = {}
        return metadata, kwds
 

getFilterNameFromInt()

def lsst.skymap.packers.SkyMapDimensionPacker.getFilterNameFromInt	(		cls,
			num
	)

Return an band name from its integer representation.

Definition at line 62 of file packers.py.

    def getFilterNameFromInt(cls, num):
        """Return an band name from its integer representation.
        """
        return cls.SUPPORTED_FILTERS[num]
 

getIntFromFilter()

def lsst.skymap.packers.SkyMapDimensionPacker.getIntFromFilter	(		cls,
			name
	)

Return an integer that represents the band with the given
name.

Definition at line 52 of file packers.py.

    def getIntFromFilter(cls, name):
        """Return an integer that represents the band with the given
        name.
        """
        try:
            return cls.SUPPORTED_FILTERS.index(name)
        except ValueError:
            raise NotImplementedError(f"band '{name}' not supported by this ID packer.")
 

getMaxIntForFilters()

def lsst.skymap.packers.SkyMapDimensionPacker.getMaxIntForFilters

(

cls

)

Definition at line 68 of file packers.py.

    def getMaxIntForFilters(cls):
        return len(cls.SUPPORTED_FILTERS)
 

maxBits()

int lsst.skymap.packers.SkyMapDimensionPacker.maxBits

(

self

)

Definition at line 92 of file packers.py.

    def maxBits(self) -> int:
        # Docstring inherited from DataIdPacker.maxBits
        packedMax = self._tractPatchMax
        if self._filterMax is not None:
            packedMax *= self._filterMax
        return packedMax.bit_length()
 

unpack()

DataCoordinate lsst.skymap.packers.SkyMapDimensionPacker.unpack	(		self,
		int	packedId
	)

Definition at line 106 of file packers.py.

    def unpack(self, packedId: int) -> DataCoordinate:
        # Docstring inherited from DataIdPacker.unpack
        d = {"skymap": self._skyMapName}
        if self._filterMax is not None:
            d["band"] = self.getFilterNameFromInt(packedId // self._tractPatchMax)
            packedId %= self._tractPatchMax
        d["tract"] = packedId // self._patchMax
        d["patch"] = packedId % self._patchMax
        return DataCoordinate.standardize(d, graph=self.dimensions)

Member Data Documentation

SUPPORTED_FILTERS

tuple lsst.skymap.packers.SkyMapDimensionPacker.SUPPORTED_FILTERS

static

Initial value:

=  (
        [None]
        + list("ugrizyUBGVRIZYJHK")  # split string into single chars
        + [f"N{d}" for d in (387, 515, 656, 816, 921, 1010)]  # HSC narrow-bands
    )

Definition at line 40 of file packers.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/skymap/22.0.1-4-g037fbe1+64e601228d/python/lsst/skymap/packers.py