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

Public Member Functions
def	__init__ (self, name, datasetType, level, doMakeDataRefList=True, ContainerClass=DataIdContainer)

def	isDynamicDatasetType (self)

def	getDatasetType (self, namespace)

Public Attributes
	name

	datasetType

	level

	doMakeDataRefList

	ContainerClass

	argName

Detailed Description

data ID argument, used by `ArgumentParser.add_id_argument`.

Parameters
----------
name : `str`
    Name of identifier (argument name without dashes).
datasetType : `str`
    Type 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).
level
    Level of dataset, for `~lsst.daf.persistence.Butler`.
doMakeDataRefList : `bool`, optional
    If `True` (default), construct data references.
ContainerClass : class, optional
    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. Default is `DataIdContainer`.

Definition at line 173 of file argumentParser.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 192 of file argumentParser.py.

Member Function Documentation

◆ getDatasetType()

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

Get the dataset type as a string.

Parameters
----------
namespace
    Parsed command.

Returns
-------
datasetType : `str`
    Dataset type.

Definition at line 207 of file argumentParser.py.

◆ isDynamicDatasetType()

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

`True` if the dataset type is dynamic (that is, specified on the command line).

Definition at line 203 of file argumentParser.py.

Member Data Documentation

◆ argName

lsst.pipe.base.argumentParser.DataIdArgument.argName

Definition at line 200 of file argumentParser.py.

◆ ContainerClass

lsst.pipe.base.argumentParser.DataIdArgument.ContainerClass

Definition at line 199 of file argumentParser.py.

◆ datasetType

lsst.pipe.base.argumentParser.DataIdArgument.datasetType

Definition at line 196 of file argumentParser.py.

◆ doMakeDataRefList

lsst.pipe.base.argumentParser.DataIdArgument.doMakeDataRefList

Definition at line 198 of file argumentParser.py.

◆ level

lsst.pipe.base.argumentParser.DataIdArgument.level

Definition at line 197 of file argumentParser.py.

◆ name

lsst.pipe.base.argumentParser.DataIdArgument.name

Definition at line 195 of file argumentParser.py.

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

python/lsst/pipe/base/argumentParser.py

Public Member Functions

Public Attributes