DatasetTypeDescriptor

class lsst.pipe.base.DatasetTypeDescriptor(datasetType, scalar, manualLoad)

Bases: object

Describe DatasetType and its options for PipelineTask.

This class contains DatasetType 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:
datasetType : DatasetType
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.

Attributes Summary

datasetType DatasetType instance.
manualLoad True if the task will handle loading the data
scalar True if this is a scalar dataset.

Methods Summary

fromConfig(datasetConfig) Make DatasetTypeDescriptor instance from configuration object.

Attributes Documentation

datasetType

DatasetType instance.

manualLoad

True if the task will handle loading the data

scalar

True if this is a scalar dataset.

Methods Documentation

classmethod fromConfig(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