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__
	Constructor. More...
def	isDynamicDatasetType
	Is the dataset type dynamic (specified on the command line)? More...
def	getDatasetType
	Get the dataset type. More...

Public Attributes
	name
	datasetType
	level
	doMakeDataRefList
	ContainerClass
	argName
	datasetTypeName

Detailed Description

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

Definition at line 130 of file argumentParser.py.

Constructor & Destructor Documentation

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

Constructor.

Parameters

[in]	name	name of identifier (argument name without dashes)
[in]	datasetType	type of dataset; specify a string for a fixed dataset type or a DatasetArgument for a dynamic dataset type (one specified on the command line), in which case an argument is added by name –<name>_dstype
[in]	level	level of dataset, for butler
[in]	doMakeDataRefList	construct data references?
[in]	ContainerClass	class 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 132 of file argumentParser.py.

    def __init__(self, name, datasetType, level, doMakeDataRefList=True, ContainerClass=DataIdContainer):
        """!Constructor

        @param[in] name         name of identifier (argument name without dashes)
        @param[in] datasetType  type of dataset; specify a string for a fixed dataset type
            or a DatasetArgument for a dynamic dataset type (one specified on the command line),
            in which case an argument is added by name --<name>_dstype
        @param[in] level        level of dataset, for butler
        @param[in] doMakeDataRefList    construct data references?
        @param[in] ContainerClass   class 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.
        """
        if name.startswith("-"):
            raise RuntimeError("Name %s must not start with -" % (name,))
        self.name = name
        self.datasetType = datasetType
        self.level = level
        self.doMakeDataRefList = bool(doMakeDataRefList)
        self.ContainerClass = ContainerClass
        self.argName = name.lstrip("-")
        if self.isDynamicDatasetType():
            self.datasetTypeName = datasetType.name if datasetType.name else self.name + "_dstype"
        else:
            self.datasetTypeName = None