LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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.

60 def dataExists(dataRef):
61  """Determine if data exists at the current level or any data exists at a deeper level.
62 
63  Parameters
64  ----------
65  dataRef : `lsst.daf.persistence.ButlerDataRef`
66  Data reference to test for existence.
67 
68  Returns
69  -------
70  exists : `bool`
71  Return value is `True` if data exists, `False` otherwise.
72  """
73  subDRList = dataRef.subItems()
74  if subDRList:
75  for subDR in subDRList:
76  if dataExists(subDR):
77  return True
78  return False
79  else:
80  return dataRef.datasetExists()

◆ 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.

29 def searchDataRefs(butler, datasetType, level="", dataId=None):
30  """Find all data references for a partial data ID.
31 
32  Parameters
33  ----------
34  butler: `lsst.daf.persistence.Butler`
35  The repository to query for data.
36  datasetType : `str`
37  The type of data references to return.
38  level : `str`
39  The level of data ID at which to search. If the empty string, the
40  default level for ``datasetType`` shall be used.
41  dataId : `lsst.daf.persistence.DataRef`, or `dict` from `str` to any
42  Butler identifier naming the data to be retrieved. If ommitted, an
43  unrestricted data ID shall be used.
44 
45  Returns
46  -------
47  dataRefs : iterable of `lsst.daf.persistence.ButlerDataRef`
48  Complete data references matching ``dataId``. Only references to
49  existing data shall be returned.
50  """
51  if dataId is None:
52  dataId = {}
53 
54  refList = butler.subset(datasetType=datasetType, level=level, dataId=dataId)
55  # exclude nonexistent data
56  # this is a recursive test, e.g. for the sake of "raw" data
57  return [dr for dr in refList if dataExists(dr)]
58 
59 
def searchDataRefs(butler, datasetType, level="", dataId=None)