lsst.pipe.base  14.0
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.argumentParser.DatasetArgument Class Reference

A dataset type specified by a command-line argument. More...

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

Public Member Functions

def __init__
 Construct a DatasetArgument. More...
 
def getDatasetType
 
def addArgument
 Add a command-line argument to specify dataset type name. More...
 
- Public Member Functions inherited from lsst.pipe.base.argumentParser.DynamicDatasetType
def addArgument
 Add a command-line argument to specify dataset type name, if wanted. More...
 
def getDatasetType
 

Public Attributes

 name
 
 help
 
 default
 

Detailed Description

A dataset type specified by a command-line argument.

Definition at line 211 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 
)

Construct a DatasetArgument.

Parameters
[in]namename 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")
[in]helphelp string for the command-line argument
[in]defaultdefault value; if None, then the command-line option is required; ignored if the argument is positional (name does not start with "-") because positional argument do not support default values

Definition at line 219 of file argumentParser.py.

Member Function Documentation

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

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

Also set self.name if it is None

Definition at line 243 of file argumentParser.py.

def lsst.pipe.base.argumentParser.DatasetArgument.getDatasetType (   self,
  namespace 
)
Return the dataset type as a string, from the appropriate command-line argument

@param[in] namespace  parsed command

Definition at line 235 of file argumentParser.py.

Member Data Documentation

lsst.pipe.base.argumentParser.DatasetArgument.default

Definition at line 233 of file argumentParser.py.

lsst.pipe.base.argumentParser.DatasetArgument.help

Definition at line 232 of file argumentParser.py.

lsst.pipe.base.argumentParser.DatasetArgument.name

Definition at line 231 of file argumentParser.py.


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