Inheritance diagram for lsst.skymap.packers.SkyMapDataIdPacker:

Public Member Functions
def	getIntFromFilter (cls, name)

def	getFilterNameFromInt (cls, num)

def	getMaxIntForFilters (cls)

def	configure (cls, dimensions)

def	__init__ (self, dimensions, skymap, tractMax, patchNxMax, patchNyMax)

def	maxBits (self)

def	unpack (self, packedId)

Static Public Attributes
list	SUPPORTED_FILTERS = [None] + list("ugrizyUBGVRIZYJHK")

Detailed Description

A `DataIdPacker` for Tract, Patch and optionally AbstractFilter, given
a SkyMap.

Parameters
----------
dimensions : `DataIdPackerDimensions`
    Struct containing dimensions related to this `DataIdPacker`.  Must
    have SkyMap as the only given dimension, Tract, Patch, and possibly
    AbstractFilter as the covered dimensions, and all of these as required
    dimensions.
skymap : `str`
    SkyMap name from `Registry`.
tractMax : `int`
    Maximum (exclusive) tract index for this skymap.
patchNxMax : `int`
    Maximum (exclusive) patch index in the x direction.
patchNyMax : `int`
    Maximum (exclusive) patch index in the y direction.

Definition at line 27 of file packers.py.

Constructor & Destructor Documentation

◆ init()

def lsst.skymap.packers.SkyMapDataIdPacker.__init__	(	self,
		dimensions,
		skymap,
		tractMax,
		patchNxMax,
		patchNyMax
	)

Definition at line 84 of file packers.py.

Member Function Documentation

◆ configure()

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

Definition at line 76 of file packers.py.

◆ getFilterNameFromInt()

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

Return an AbstractFilter name from its integer representation.

Definition at line 66 of file packers.py.

◆ getIntFromFilter()

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

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

Definition at line 56 of file packers.py.

◆ getMaxIntForFilters()

def lsst.skymap.packers.SkyMapDataIdPacker.getMaxIntForFilters ( cls )

Definition at line 72 of file packers.py.

◆ maxBits()

def lsst.skymap.packers.SkyMapDataIdPacker.maxBits ( self )

Definition at line 94 of file packers.py.

◆ unpack()

def lsst.skymap.packers.SkyMapDataIdPacker.unpack	(	self,
		packedId
	)

Definition at line 108 of file packers.py.

Member Data Documentation

◆ SUPPORTED_FILTERS

list lsst.skymap.packers.SkyMapDataIdPacker.SUPPORTED_FILTERS = [None] + list("ugrizyUBGVRIZYJHK")

static

Definition at line 48 of file packers.py.

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

python/lsst/skymap/packers.py

Public Member Functions

Static Public Attributes