lsst.obs.base  13.0-55-gb064ced+3
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.exposureIdInfo.ExposureIdInfo Class Reference

Exposure ID and number of bits used. More...

Inheritance diagram for lsst.obs.base.exposureIdInfo.ExposureIdInfo:

Public Member Functions

def __init__ (self, expId=0, expBits=1, maxBits=64)
 Construct an ExposureIdInfo. More...
 
def unusedBits (self)
 

Public Attributes

 expId
 
 expBits
 
 maxBits
 

Detailed Description

Exposure ID and number of bits used.

Attributes include:

One common use is creating an ID factory for making a source table. For example, given a data butler butler and a data ID dataId:

from lsst.afw.table import IdFactory, SourceTable
exposureIdInfo = butler.get("expIdInfo", dataId)
sourceIdFactory = IdFactory.makeSource(exposureIdInfo.expId, exposureIdInfo.unusedBits)
schema = SourceTable.makeMinimalSchema()
#...add fields to schema as desired, then...
sourceTable = SourceTable.make(self.schema, sourceIdFactory)

At least one bit must be reserved, even if there is no exposure ID, for reasons that are not entirely clear (this is DM-6664).

Definition at line 29 of file exposureIdInfo.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.exposureIdInfo.ExposureIdInfo.__init__ (   self,
  expId = 0,
  expBits = 1,
  maxBits = 64 
)

Construct an ExposureIdInfo.

See the class doc string for an explanation of the arguments.

Definition at line 53 of file exposureIdInfo.py.

Member Function Documentation

◆ unusedBits()

def lsst.obs.base.exposureIdInfo.ExposureIdInfo.unusedBits (   self)

Definition at line 72 of file exposureIdInfo.py.

Member Data Documentation

◆ expBits

lsst.obs.base.exposureIdInfo.ExposureIdInfo.expBits

Definition at line 68 of file exposureIdInfo.py.

◆ expId

lsst.obs.base.exposureIdInfo.ExposureIdInfo.expId

Definition at line 67 of file exposureIdInfo.py.

◆ maxBits

lsst.obs.base.exposureIdInfo.ExposureIdInfo.maxBits

Definition at line 69 of file exposureIdInfo.py.


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