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 = pexConfig.Config

	RunnerClass = DataRefListRunner

Detailed Description

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

Definition at line 68 of file getRepositoryData.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 75 of file getRepositoryData.py.

     def __init__(self, *args, **kwargs):
         pipeBase.CmdLineTask.__init__(self, *args, **kwargs)
  

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 108 of file getRepositoryData.py.

     def 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)
         """
         return [dataRef.get(datasetType=datasetType) for dataRef in dataRefList]
  

◆ 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 86 of file getRepositoryData.py.

     def 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
         """
         if not dataRefList:
             raise RuntimeError("No data refs")
         idKeyTuple = tuple(sorted(dataRefList[0].dataId.keys()))
  
         idValList = []
         for dataRef in dataRefList:
             idValTuple = tuple(dataRef.dataId[key] for key in idKeyTuple)
             idValList.append(idValTuple)
  
         return pipeBase.Struct(
             idKeyTuple=idKeyTuple,
             idValList=idValList,
         )
  

◆ 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 117 of file getRepositoryData.py.

     def 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
         """
         valList = []
         for dataRef in dataRefList:
             metadata = dataRef.get(datasetType=datasetType)
             valList.append(dict((name, metadata.getArray(name)) for name in nameList))
         return valList

◆ 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 79 of file getRepositoryData.py.

     def runDataRef(self, dataRefList):
         """Get data from a repository for a collection of data references
  
         @param dataRefList: a list of data references
         """
         raise NotImplementedError("subclass must specify a run method")
  

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.ConfigClass = pexConfig.Config

static

Definition at line 71 of file getRepositoryData.py.

◆ RunnerClass

lsst.pipe.tasks.getRepositoryData.GetRepositoryDataTask.RunnerClass = DataRefListRunner