lsst.pipe.base  13.0-12-gaf0c0ec+8
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.argumentParser.DataIdArgument Class Reference

Glorified struct for data about id arguments, used by ArgumentParser.add_id_argument. More...

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

Public Member Functions

def __init__ (self, name, datasetType, level, doMakeDataRefList=True, ContainerClass=DataIdContainer)
 Constructor. More...
 
def isDynamicDatasetType (self)
 Is the dataset type dynamic (specified on the command line)? More...
 
def getDatasetType (self, namespace)
 Return the dataset type as a string. More...
 

Public Attributes

 name
 
 datasetType
 
 level
 
 doMakeDataRefList
 
 ContainerClass
 
 argName
 

Detailed Description

Glorified struct for data about id arguments, used by ArgumentParser.add_id_argument.

Definition at line 148 of file argumentParser.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.argumentParser.DataIdArgument.__init__ (   self,
  name,
  datasetType,
  level,
  doMakeDataRefList = True,
  ContainerClass = DataIdContainer 
)

Constructor.

Parameters
[in]namename of identifier (argument name without dashes)
[in]datasetTypetype of dataset; specify a string for a fixed dataset type or a DatasetArgument for a dynamic dataset type (e.g. one specified by a command-line argument)
[in]levellevel of dataset, for butler
[in]doMakeDataRefListconstruct data references?
[in]ContainerClassclass to contain data IDs and data references; the default class will work for many kinds of data, but you may have to override to compute some kinds of data references.

Definition at line 151 of file argumentParser.py.

Member Function Documentation

◆ getDatasetType()

def lsst.pipe.base.argumentParser.DataIdArgument.getDatasetType (   self,
  namespace 
)

Return the dataset type as a string.

Parameters
[in]namespaceparsed command

Definition at line 177 of file argumentParser.py.

◆ isDynamicDatasetType()

def lsst.pipe.base.argumentParser.DataIdArgument.isDynamicDatasetType (   self)

Is the dataset type dynamic (specified on the command line)?

Definition at line 173 of file argumentParser.py.

Member Data Documentation

◆ argName

lsst.pipe.base.argumentParser.DataIdArgument.argName

Definition at line 170 of file argumentParser.py.

◆ ContainerClass

lsst.pipe.base.argumentParser.DataIdArgument.ContainerClass

Definition at line 169 of file argumentParser.py.

◆ datasetType

lsst.pipe.base.argumentParser.DataIdArgument.datasetType

Definition at line 166 of file argumentParser.py.

◆ doMakeDataRefList

lsst.pipe.base.argumentParser.DataIdArgument.doMakeDataRefList

Definition at line 168 of file argumentParser.py.

◆ level

lsst.pipe.base.argumentParser.DataIdArgument.level

Definition at line 167 of file argumentParser.py.

◆ name

lsst.pipe.base.argumentParser.DataIdArgument.name

Definition at line 165 of file argumentParser.py.


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