lsst.pipe.tasks  18.1.0-30-gf271f1f5+3
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask Class Reference
Inheritance diagram for lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask:

Public Member Functions

def __init__ (self, args, kwargs)
 
def runDataRef (self, dataRefList)
 
def getIdList (self, dataRefList)
 
def getDataList (self, dataRefList, datasetType)
 
def getMetadataItems (self, dataRefList, datasetType, nameList)
 

Static Public Attributes

 ConfigClass
 
 RunnerClass
 

Detailed Description

Retrieve data from a repository, e.g. for plotting or analysis purposes

Definition at line 67 of file getRepositoryData.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.__init__ (   self,
  args,
  kwargs 
)

Definition at line 74 of file getRepositoryData.py.

Member Function Documentation

◆ getDataList()

def lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.getDataList (   self,
  dataRefList,
  datasetType 
)
Retrieve a list of data

@param dataRefList: a list of data references
@param datasetType: datasetType of data to be retrieved
@return a list of data, one entry per dataRef in dataRefList (in order)

Definition at line 107 of file getRepositoryData.py.

◆ getIdList()

def lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.getIdList (   self,
  dataRefList 
)
Get a list of data IDs in a form that can be used as dictionary keys

@param dataRefList: a list of data references
@return a pipe_base Struct with fields:
- idKeyTuple: a tuple of dataRef data ID keys
- idValList: a list of data ID value tuples, each tuple contains values in the order in idKeyTuple

Definition at line 85 of file getRepositoryData.py.

◆ getMetadataItems()

def lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.getMetadataItems (   self,
  dataRefList,
  datasetType,
  nameList 
)
Retrieve a list of dictionaries of metadata

@param dataRefList: a list of data references
@param datasetType: datasetType of metadata (or any object that supports get(name))
@return a list of dicts of metadata:
- each entry in the list corresponds to a dataRef in dataRefList
- each dict contains name: item of metadata, for each name in nameList;
    numeric and string values will be returned as arrays

Definition at line 116 of file getRepositoryData.py.

◆ runDataRef()

def lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.runDataRef (   self,
  dataRefList 
)
Get data from a repository for a collection of data references

@param dataRefList: a list of data references

Definition at line 78 of file getRepositoryData.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.ConfigClass
static

Definition at line 70 of file getRepositoryData.py.

◆ RunnerClass

lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.RunnerClass
static

Definition at line 71 of file getRepositoryData.py.


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