lsst.pipe.base
17.0.1-5-g3877d06+10
|
Public Member Functions | |
def | __init__ (self, name, dimensionNames, storageClassName, scalar, manualLoad) |
def | fromConfig (cls, datasetConfig) |
def | makeDatasetType (self, universe) |
def | name (self) |
def | scalar (self) |
def | manualLoad (self) |
Description of an unnormalized proto-DatasetType and its relationship to a PipelineTask. This class contains the information needed to construct a `DatasetType` (once a `DimensionUniverse` is available) and all relevant options that are used by PipelineTask. Typically this is derived from configuration classes, but sub-classes of PipelineTask can also define additional DatasetTypes that are not part of the task configuration. Parameters ---------- name : `str` Name of the dataset type. dimensionNames: `~collections.abc.Set` of `str` Names of the dimensions used to identify datasets of this type. storageClassName: `str` Name of the `~lsst.daf.butler.StorageClass` for this dataset type. scalar : `bool` `True` if this is a scalar dataset. manualLoad : `bool` `True` if this dataset will be manually loaded by a concrete `PipelineTask` instead of loaded automatically by the base class.
Definition at line 49 of file pipelineTask.py.
def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.__init__ | ( | self, | |
name, | |||
dimensionNames, | |||
storageClassName, | |||
scalar, | |||
manualLoad | |||
) |
Definition at line 74 of file pipelineTask.py.
def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.fromConfig | ( | cls, | |
datasetConfig | |||
) |
Make DatasetTypeDescriptor instance from configuration object. Parameters ---------- datasetConfig : `lsst.pex.config.Config` Instance of one the `InputDatasetConfig`, `OutputDatasetConfig`, `InitInputDatasetConfig`, or `InitOutputDatasetConfig` types Returns ------- descriptor : `DatasetTypeDescriptor`
Definition at line 82 of file pipelineTask.py.
def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.makeDatasetType | ( | self, | |
universe | |||
) |
Construct a true `DatasetType` instance with normalized dimensions. Parameters ---------- universe : `lsst.daf.butler.DimensionUniverse` Set of all known dimensions to be used to normalize the dimension names specified in config. Returns ------- datasetType : `DatasetType` The `DatasetType` defined by this descriptor.
Definition at line 101 of file pipelineTask.py.
def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.manualLoad | ( | self | ) |
`True` if the task will handle loading the data
Definition at line 132 of file pipelineTask.py.
def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.name | ( | self | ) |
Name of the dataset type (`str`).
Definition at line 120 of file pipelineTask.py.
def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.scalar | ( | self | ) |
`True` if this is a scalar dataset.
Definition at line 126 of file pipelineTask.py.