lsst.skymap  18.1.0-1-g380d4d4+21
Public Member Functions | Static Public Attributes | List of all members
lsst.skymap.packers.SkyMapDataIdPacker Class Reference
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 abstract_filter, 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
    abstract_filter 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 abstract_filter 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 abstract_filter 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: