lsst.pipe.base.argumentParser.DynamicDatasetType Class Reference

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

Public Member Functions
def	addArgument (self, parser, idName)
def	getDatasetType (self, namespace)

Detailed Description

Abstract base class for a dataset type determined from parsed
command-line arguments.

Definition at line 265 of file argumentParser.py.

Member Function Documentation

addArgument()

def lsst.pipe.base.argumentParser.DynamicDatasetType.addArgument	(		self,
			parser,
			idName
	)

Add a command-line argument to specify dataset type name,
if wanted.

Parameters
----------
parser : `ArgumentParser`
    Argument parser to add the argument to.
idName : `str`
    Name of data ID argument, without the leading ``"--"``,
    e.g. ``"id"``.

Notes
-----
The default implementation does nothing

Reimplemented in lsst.pipe.base.argumentParser.DatasetArgument.

Definition at line 270 of file argumentParser.py.

    def addArgument(self, parser, idName):
        """Add a command-line argument to specify dataset type name,
        if wanted.
 
        Parameters
        ----------
        parser : `ArgumentParser`
            Argument parser to add the argument to.
        idName : `str`
            Name of data ID argument, without the leading ``"--"``,
            e.g. ``"id"``.
 
        Notes
        -----
        The default implementation does nothing
        """
        pass
 

getDatasetType()

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

Get the dataset type as a string, based on parsed command-line
arguments.

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

Reimplemented in lsst.pipe.base.argumentParser.ConfigDatasetType, and lsst.pipe.base.argumentParser.DatasetArgument.

Definition at line 289 of file argumentParser.py.

    def getDatasetType(self, namespace):
        """Get the dataset type as a string, based on parsed command-line
        arguments.
 
        Returns
        -------
        datasetType : `str`
            Dataset type.
        """
        raise NotImplementedError("Subclasses must override")
 
 

---

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