lsst.pipe.base.argumentParser.DataIdArgument Class Reference

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 : `str`
    The lowest hierarchy level to descend to for this dataset type,
    for example `"amp"` for `"raw"` or `"ccd"` for `"calexp"`.
    Use `""` to use the mapper's default for the dataset type.
    Some container classes may also support `None`, which means
    the level should not be restricted; however the default class,
    `DataIdContainer`, does not support `None`.
doMakeDataRefList : `bool`, optional
    If `True` (default), construct data references.
ContainerClass : `class`, optional
    Class to contain data IDs and data references; the default class
    `DataIdContainer` will work for many, but not all, cases.
    For example if the dataset type is specified on the command line
    then use `DynamicDatasetType`.

Definition at line 202 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 229 of file argumentParser.py.

    def __init__(self, name, datasetType, level, doMakeDataRefList=True, ContainerClass=DataIdContainer):
        if name.startswith("-"):
            raise RuntimeError(f"Name {name} must not start with -")
        self.name = name
        self.datasetType = datasetType
        self.level = level
        self.doMakeDataRefList = bool(doMakeDataRefList)
        self.ContainerClass = ContainerClass
        self.argName = name.lstrip("-")
 

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

    def getDatasetType(self, namespace):
        """Get the dataset type as a string.
 
        Parameters
        ----------
        namespace
            Parsed command.
 
        Returns
        -------
        datasetType : `str`
            Dataset type.
        """
        if self.isDynamicDatasetType:
            return self.datasetType.getDatasetType(namespace)
        else:
            return self.datasetType
 
 

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

    def isDynamicDatasetType(self):
        """`True` if the dataset type is dynamic (that is, specified
        on the command line).
        """
        return isinstance(self.datasetType, DynamicDatasetType)
 

Member Data Documentation

argName

lsst.pipe.base.argumentParser.DataIdArgument.argName

Definition at line 237 of file argumentParser.py.

ContainerClass

lsst.pipe.base.argumentParser.DataIdArgument.ContainerClass

Definition at line 236 of file argumentParser.py.

datasetType

lsst.pipe.base.argumentParser.DataIdArgument.datasetType

Definition at line 233 of file argumentParser.py.

doMakeDataRefList

lsst.pipe.base.argumentParser.DataIdArgument.doMakeDataRefList

Definition at line 235 of file argumentParser.py.

level

lsst.pipe.base.argumentParser.DataIdArgument.level

Definition at line 234 of file argumentParser.py.

name

lsst.pipe.base.argumentParser.DataIdArgument.name

Definition at line 232 of file argumentParser.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/pipe_base/22.0.1+94e66cc9ed/python/lsst/pipe/base/argumentParser.py