lsst.skymap 22.0.1-8-gd542723+ec07468f3b
Public Member Functions | Static Public Attributes | List of all members
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 81 of file packers.py.

Member Function Documentation

◆ configure()

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

Definition at line 73 of file packers.py.

◆ getFilterNameFromInt()

def lsst.skymap.packers.SkyMapDimensionPacker.getFilterNameFromInt (   cls,
  num 
)
Return an band name from its integer representation.

Definition at line 63 of file packers.py.

◆ getIntFromFilter()

def lsst.skymap.packers.SkyMapDimensionPacker.getIntFromFilter (   cls,
  name 
)
Return an integer that represents the band with the given
name.

Definition at line 53 of file packers.py.

◆ getMaxIntForFilters()

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

Definition at line 69 of file packers.py.

◆ maxBits()

int lsst.skymap.packers.SkyMapDimensionPacker.maxBits (   self)

Definition at line 93 of file packers.py.

◆ unpack()

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

Definition at line 107 of file packers.py.

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
+ [f"N{d}" for d in (419, 540, 708, 964)] # DECam narrow-bands
)

Definition at line 40 of file packers.py.


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