lsst.pipe.base.argumentParser.DatasetArgument Class Reference

Specify that the dataset type should be a command-line option. More...

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

Public Member Functions
def	__init__
def	required

Public Attributes
	name
	help
	default

Detailed Description

Specify that the dataset type should be a command-line option.

Somewhat more heavyweight than just using, e.g., None as a signal, but provides the ability to have more informative help and a default. Also more extensible in the future.

Parameters

[in]	name	name of command-line argument (including leading "--", if wanted); if omitted a suitable default is chosen
[in]	help	help string for the command-line option
[in]	default	default value; if None, then the option is required

Definition at line 171 of file argumentParser.py.

Constructor & Destructor Documentation

def lsst.pipe.base.argumentParser.DatasetArgument.__init__	(		self,
			name = None,
			help = "dataset type to process from input data repository",
			default = None
	)

Definition at line 187 of file argumentParser.py.

    ):
        self.name = name
        self.help = help
        self.default = default