lsst.pipe.base  13.0-9-g1c7d9c5+10
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.argumentParser.DataIdContainer Class Reference

A container for data IDs and associated data references. More...

Inheritance diagram for lsst.pipe.base.argumentParser.DataIdContainer:

Public Member Functions

def __init__
 Construct a DataIdContainer. More...
 
def setDatasetType
 Set actual dataset type, once it is known. More...
 
def castDataIds
 Validate data IDs and cast them to the correct type (modify idList in place). More...
 
def makeDataRefList
 Compute refList based on idList. More...
 

Public Attributes

 datasetType
 
 level
 
 idList
 
 refList
 

Detailed Description

A container for data IDs and associated data references.

Override for data IDs that require special handling to be converted to data references, and specify the override class as ContainerClass for add_id_argument. (If you don't want the argument parser to compute data references, you may use this class and specify doMakeDataRefList=False in add_id_argument.)

Definition at line 73 of file argumentParser.py.

Constructor & Destructor Documentation

def lsst.pipe.base.argumentParser.DataIdContainer.__init__ (   self,
  level = None 
)

Construct a DataIdContainer.

Definition at line 82 of file argumentParser.py.

Member Function Documentation

def lsst.pipe.base.argumentParser.DataIdContainer.castDataIds (   self,
  butler 
)

Validate data IDs and cast them to the correct type (modify idList in place).

Parameters
[in]butlerdata butler (a lsst.daf.persistence.Butler)

Definition at line 93 of file argumentParser.py.

def lsst.pipe.base.argumentParser.DataIdContainer.makeDataRefList (   self,
  namespace 
)

Compute refList based on idList.

Not called if add_id_argument called with doMakeDataRefList=False

Parameters
[in]namespaceresults of parsing command-line (with 'butler' and 'log' elements)

Definition at line 126 of file argumentParser.py.

def lsst.pipe.base.argumentParser.DataIdContainer.setDatasetType (   self,
  datasetType 
)

Set actual dataset type, once it is known.

Definition at line 89 of file argumentParser.py.

Member Data Documentation

lsst.pipe.base.argumentParser.DataIdContainer.datasetType

Definition at line 84 of file argumentParser.py.

lsst.pipe.base.argumentParser.DataIdContainer.idList

Definition at line 86 of file argumentParser.py.

lsst.pipe.base.argumentParser.DataIdContainer.level

Definition at line 85 of file argumentParser.py.

lsst.pipe.base.argumentParser.DataIdContainer.refList

Definition at line 87 of file argumentParser.py.


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