LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
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()
81 

◆ 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 
lsst::daf::persistence.butlerHelpers.searchDataRefs
def searchDataRefs(butler, datasetType, level="", dataId=None)
Definition: butlerHelpers.py:29
Generated on Sat Nov 16 2019 09:15:32 for LSSTApplications by   doxygen 1.8.13