lsst.pipe.base
21.0.0-16-g0fb55c1+f4b3a4d7bd
|
Public Member Functions | |
def | __init__ (self, name, datasetType, level, doMakeDataRefList=True, ContainerClass=DataIdContainer) |
def | isDynamicDatasetType (self) |
def | getDatasetType (self, namespace) |
Public Attributes | |
name | |
datasetType | |
level | |
doMakeDataRefList | |
ContainerClass | |
argName | |
data ID argument, used by `ArgumentParser.add_id_argument`. Parameters ---------- name : `str` Name of identifier (argument name without dashes). datasetType : `str` Type of dataset; specify a string for a fixed dataset type or a `DatasetArgument` for a dynamic dataset type (e.g. one specified by a command-line argument). level : `str` The lowest hierarchy level to descend to for this dataset type, for example `"amp"` for `"raw"` or `"ccd"` for `"calexp"`. Use `""` to use the mapper's default for the dataset type. Some container classes may also support `None`, which means the level should not be restricted; however the default class, `DataIdContainer`, does not support `None`. doMakeDataRefList : `bool`, optional If `True` (default), construct data references. ContainerClass : `class`, optional Class to contain data IDs and data references; the default class `DataIdContainer` will work for many, but not all, cases. For example if the dataset type is specified on the command line then use `DynamicDatasetType`.
Definition at line 202 of file argumentParser.py.
def lsst.pipe.base.argumentParser.DataIdArgument.__init__ | ( | self, | |
name, | |||
datasetType, | |||
level, | |||
doMakeDataRefList = True , |
|||
ContainerClass = DataIdContainer |
|||
) |
Definition at line 229 of file argumentParser.py.
def lsst.pipe.base.argumentParser.DataIdArgument.getDatasetType | ( | self, | |
namespace | |||
) |
Get the dataset type as a string. Parameters ---------- namespace Parsed command. Returns ------- datasetType : `str` Dataset type.
Definition at line 246 of file argumentParser.py.
def lsst.pipe.base.argumentParser.DataIdArgument.isDynamicDatasetType | ( | self | ) |
`True` if the dataset type is dynamic (that is, specified on the command line).
Definition at line 240 of file argumentParser.py.
lsst.pipe.base.argumentParser.DataIdArgument.argName |
Definition at line 237 of file argumentParser.py.
lsst.pipe.base.argumentParser.DataIdArgument.ContainerClass |
Definition at line 236 of file argumentParser.py.
lsst.pipe.base.argumentParser.DataIdArgument.datasetType |
Definition at line 233 of file argumentParser.py.
lsst.pipe.base.argumentParser.DataIdArgument.doMakeDataRefList |
Definition at line 235 of file argumentParser.py.
lsst.pipe.base.argumentParser.DataIdArgument.level |
Definition at line 234 of file argumentParser.py.
lsst.pipe.base.argumentParser.DataIdArgument.name |
Definition at line 232 of file argumentParser.py.