lsst.daf.persistence  21.0.0-7-g98eecf7+205433fbda
Functions
lsst.daf.persistence.butlerHelpers Namespace Reference

Functions

def searchDataRefs (butler, datasetType, level="", dataId=None)
 
def dataExists (dataRef)
 

Function Documentation

◆ dataExists()

def lsst.daf.persistence.butlerHelpers.dataExists (   dataRef)
Determine if data exists at the current level or any data exists at a deeper level.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Data reference to test for existence.

Returns
-------
exists : `bool`
    Return value is `True` if data exists, `False` otherwise.

Definition at line 60 of file butlerHelpers.py.

◆ searchDataRefs()

def lsst.daf.persistence.butlerHelpers.searchDataRefs (   butler,
  datasetType,
  level = "",
  dataId = None 
)
Find all data references for a partial data ID.

Parameters
----------
butler: `lsst.daf.persistence.Butler`
    The repository to query for data.
datasetType : `str`
    The type of data references to return.
level : `str`
    The level of data ID at which to search. If the empty string, the
    default level for ``datasetType`` shall be used.
dataId : `lsst.daf.persistence.DataRef`, or `dict` from `str` to any
    Butler identifier naming the data to be retrieved. If ommitted, an
    unrestricted data ID shall be used.

Returns
-------
dataRefs : iterable of `lsst.daf.persistence.ButlerDataRef`
    Complete data references matching ``dataId``. Only references to
    existing data shall be returned.

Definition at line 29 of file butlerHelpers.py.