lsst.pipe.base  17.0.1-3-g924bd39+1
Public Member Functions | List of all members
lsst.pipe.base.pipelineTask.DatasetTypeDescriptor Class Reference

Public Member Functions

def __init__ (self, datasetType, scalar, manualLoad)
 
def fromConfig (cls, datasetConfig)
 
def datasetType (self)
 
def scalar (self)
 
def manualLoad (self)
 

Detailed Description

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.

Definition at line 49 of file pipelineTask.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.__init__ (   self,
  datasetType,
  scalar,
  manualLoad 
)

Definition at line 67 of file pipelineTask.py.

Member Function Documentation

◆ datasetType()

def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.datasetType (   self)
`DatasetType` instance.

Definition at line 95 of file pipelineTask.py.

◆ fromConfig()

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 73 of file pipelineTask.py.

◆ manualLoad()

def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.manualLoad (   self)
`True` if the task will handle loading the data

Definition at line 107 of file pipelineTask.py.

◆ scalar()

def lsst.pipe.base.pipelineTask.DatasetTypeDescriptor.scalar (   self)
`True` if this is a scalar dataset.

Definition at line 101 of file pipelineTask.py.


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