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

Public Member Functions
def	__init__ (self, level=None)

def	setDatasetType (self, datasetType)

def	castDataIds (self, butler)

def	makeDataRefList (self, namespace)

Public Attributes
	datasetType

	level

	idList

	refList

Detailed Description

Container for data IDs and associated data references.

Parameters
----------
level
    Unknown.

Notes
-----
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 79 of file argumentParser.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 95 of file argumentParser.py.

Member Function Documentation

◆ castDataIds()

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

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

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler.

Definition at line 111 of file argumentParser.py.

◆ makeDataRefList()

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

Compute refList based on idList.

Parameters
----------
namespace
    Results of parsing command-line (with ``butler`` and ``log`` elements).

Notes
-----
Not called if ``add_id_argument`` called with ``doMakeDataRefList=False``.

Definition at line 146 of file argumentParser.py.

◆ setDatasetType()

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

Set actual dataset type, once it is known.

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

Definition at line 101 of file argumentParser.py.

Member Data Documentation

◆ datasetType

lsst.pipe.base.argumentParser.DataIdContainer.datasetType

Definition at line 96 of file argumentParser.py.

◆ idList

lsst.pipe.base.argumentParser.DataIdContainer.idList

Definition at line 98 of file argumentParser.py.

◆ level

lsst.pipe.base.argumentParser.DataIdContainer.level

Definition at line 97 of file argumentParser.py.

◆ refList

lsst.pipe.base.argumentParser.DataIdContainer.refList

Definition at line 99 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