DatasetArgument¶
-
class
lsst.pipe.base.
DatasetArgument
(name=None, help='dataset type to process from input data repository', default=None)¶ Bases:
lsst.pipe.base.argumentParser.DynamicDatasetType
Dataset type specified by a command-line argument.
Parameters: - name :
str
, optional Name of command-line argument (including leading “–”, if appropriate) whose value is the dataset type. If
None
, uses--idName_dstype
where idName is the name of the data ID argument (e.g. “id”).- help :
str
, optional Help string for the command-line argument.
- default :
object
, optional Default value. If
None
, then the command-line option is required. This argument isignored if the command-line argument is positional (name does not start with “-“) because positional arguments do not support default values.
Methods Summary
addArgument
(parser, idName)Add a command-line argument to specify the dataset type name. getDatasetType
(namespace)Get the dataset type as a string, from the appropriate command-line argument. Methods Documentation
-
addArgument
(parser, idName)¶ Add a command-line argument to specify the dataset type name.
Parameters: - parser :
ArgumentParser
Argument parser.
- idName :
str
Data ID.
Notes
Also sets the
name
attribute if it is currentlyNone
.- parser :
- name :