lsst.pipe.base  13.0-14-g8b3bf66+1
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.argumentParser.DatasetArgument Class Reference
Inheritance diagram for lsst.pipe.base.argumentParser.DatasetArgument:
lsst.pipe.base.argumentParser.DynamicDatasetType

Public Member Functions

def __init__
 
def getDatasetType
 
def addArgument
 
- Public Member Functions inherited from lsst.pipe.base.argumentParser.DynamicDatasetType
def addArgument
 
def getDatasetType
 

Public Attributes

 name
 
 help
 
 default
 

Detailed Description

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 : obj, 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.

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

Member Function Documentation

def lsst.pipe.base.argumentParser.DatasetArgument.addArgument (   self,
  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 currently `None`.

Definition at line 301 of file argumentParser.py.

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

Parameters
----------
namespace
    Parsed command.

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

Definition at line 285 of file argumentParser.py.

Member Data Documentation

lsst.pipe.base.argumentParser.DatasetArgument.default

Definition at line 283 of file argumentParser.py.

lsst.pipe.base.argumentParser.DatasetArgument.help

Definition at line 282 of file argumentParser.py.

lsst.pipe.base.argumentParser.DatasetArgument.name

Definition at line 281 of file argumentParser.py.


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