lsst.pipe.base  20.0.0-9-gabd0d4c+2d59dce445
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.argumentParser.ConfigDatasetType Class Reference
Inheritance diagram for lsst.pipe.base.argumentParser.ConfigDatasetType:
lsst.pipe.base.argumentParser.DynamicDatasetType

Public Member Functions

def __init__ (self, name)
 
def getDatasetType (self, namespace)
 
def addArgument (self, parser, idName)
 

Public Attributes

 name
 

Detailed Description

Dataset type specified by a config parameter.

Parameters
----------
name : `str`
    Name of config option whose value is the dataset type.

Definition at line 373 of file argumentParser.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.argumentParser.ConfigDatasetType.__init__ (   self,
  name 
)

Definition at line 382 of file argumentParser.py.

Member Function Documentation

◆ addArgument()

def lsst.pipe.base.argumentParser.DynamicDatasetType.addArgument (   self,
  parser,
  idName 
)
inherited
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 269 of file argumentParser.py.

◆ getDatasetType()

def lsst.pipe.base.argumentParser.ConfigDatasetType.getDatasetType (   self,
  namespace 
)
Return the dataset type as a string, from the appropriate
config field.

Parameters
----------
namespace : `argparse.Namespace`
    Parsed command.

Reimplemented from lsst.pipe.base.argumentParser.DynamicDatasetType.

Definition at line 386 of file argumentParser.py.

Member Data Documentation

◆ name

lsst.pipe.base.argumentParser.ConfigDatasetType.name

Definition at line 384 of file argumentParser.py.


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