LSSTApplications  17.0+10,17.0+51,17.0+88,18.0.0+10,18.0.0+15,18.0.0+34,18.0.0+4,18.0.0+6,18.0.0-2-ge43143a+6,18.1.0-1-g0001055+2,18.1.0-1-g0896a44+10,18.1.0-1-g1349e88+9,18.1.0-1-g2505f39+7,18.1.0-1-g380d4d4+9,18.1.0-1-g5e4b7ea+2,18.1.0-1-g7e8fceb,18.1.0-1-g85f8cd4+7,18.1.0-1-g9a6769a+3,18.1.0-1-ga1a4c1a+6,18.1.0-1-gc037db8+2,18.1.0-1-gd55f500+3,18.1.0-1-ge10677a+7,18.1.0-10-g73b8679e+12,18.1.0-12-gf30922b,18.1.0-13-g451e75588,18.1.0-13-gbfe7f7f,18.1.0-2-g31c43f9+7,18.1.0-2-g9c63283+9,18.1.0-2-gdf0b915+9,18.1.0-2-gf03bb23+2,18.1.0-3-g52aa583+3,18.1.0-3-g8f4a2b1+1,18.1.0-3-g9cb968e+8,18.1.0-4-g7bbbad0,18.1.0-5-g510c42a+8,18.1.0-5-ga46117f,18.1.0-5-gaeab27e+9,18.1.0-6-gdda7f3e+11,18.1.0-8-g4084bf03+1,w.2019.34
LSSTDataManagementBasePackage
Functions
lsst.pipe.tasks.coaddHelpers Namespace Reference

Functions

def groupDataRefs (keys, dataRefIterable)
 
def groupPatchExposures (patchDataRef, calexpDataRefList, coaddDatasetType="deepCoadd", tempExpDatasetType="deepCoadd_directWarp")
 
def getGroupDataId (groupTuple, keys)
 
def getGroupDataRef (butler, datasetType, groupTuple, keys)
 

Function Documentation

◆ getGroupDataId()

def lsst.pipe.tasks.coaddHelpers.getGroupDataId (   groupTuple,
  keys 
)
Reconstitute a data identifier from a tuple and corresponding keys

@param groupTuple: Tuple with values specifying a group
@param keys: List of keys for group tuple
@return Data identifier dict

Definition at line 87 of file coaddHelpers.py.

87 def getGroupDataId(groupTuple, keys):
88  """Reconstitute a data identifier from a tuple and corresponding keys
89 
90  @param groupTuple: Tuple with values specifying a group
91  @param keys: List of keys for group tuple
92  @return Data identifier dict
93  """
94  if len(groupTuple) != len(keys):
95  raise RuntimeError("Number of values (%d) and keys (%d) do not match" % (len(groupTuple), len(keys)))
96  return dict(zip(keys, groupTuple))
97 
98 
def getGroupDataId(groupTuple, keys)
Definition: coaddHelpers.py:87

◆ getGroupDataRef()

def lsst.pipe.tasks.coaddHelpers.getGroupDataRef (   butler,
  datasetType,
  groupTuple,
  keys 
)
Construct a data reference from a tuple and corresponding keys

@param butler: Data butler
@param datasetType: Name of dataset
@param groupTuple: Tuple with values specifying a group
@param keys: List of keys for group tuple
@return Data reference

Definition at line 99 of file coaddHelpers.py.

99 def getGroupDataRef(butler, datasetType, groupTuple, keys):
100  """Construct a data reference from a tuple and corresponding keys
101 
102  @param butler: Data butler
103  @param datasetType: Name of dataset
104  @param groupTuple: Tuple with values specifying a group
105  @param keys: List of keys for group tuple
106  @return Data reference
107  """
108  dataId = getGroupDataId(groupTuple, keys)
109  return butler.dataRef(datasetType=datasetType, dataId=dataId)
110 
def getGroupDataRef(butler, datasetType, groupTuple, keys)
Definition: coaddHelpers.py:99
def getGroupDataId(groupTuple, keys)
Definition: coaddHelpers.py:87

◆ groupDataRefs()

def lsst.pipe.tasks.coaddHelpers.groupDataRefs (   keys,
  dataRefIterable 
)
Group data references by data identifier value-tuple.

Value-tuples are built from the values of the given keys.
The effect is that the data references in each group have the same
values for the provided keys.

@param keys: List of keys to consider when grouping (order is important)
@param dataRefIterable: Iterable of data references to group
@return Dict of <value-tuple>: <list of data references for group>

Definition at line 35 of file coaddHelpers.py.

35 def groupDataRefs(keys, dataRefIterable):
36  """Group data references by data identifier value-tuple.
37 
38  Value-tuples are built from the values of the given keys.
39  The effect is that the data references in each group have the same
40  values for the provided keys.
41 
42  @param keys: List of keys to consider when grouping (order is important)
43  @param dataRefIterable: Iterable of data references to group
44  @return Dict of <value-tuple>: <list of data references for group>
45  """
46  groupDict = dict()
47  for dataRef in dataRefIterable:
48  dataId = dataRef.dataId
49  values = tuple(dataId[key] for key in keys) # NOT dataId.values() as we must preserve order
50  group = groupDict.get(values)
51  if group:
52  group.append(dataRef)
53  else:
54  groupDict[values] = [dataRef]
55 
56  return groupDict
57 
58 
def groupDataRefs(keys, dataRefIterable)
Definition: coaddHelpers.py:35

◆ groupPatchExposures()

def lsst.pipe.tasks.coaddHelpers.groupPatchExposures (   patchDataRef,
  calexpDataRefList,
  coaddDatasetType = "deepCoadd",
  tempExpDatasetType = "deepCoadd_directWarp" 
)
Group calibrated exposures overlapping a patch by the warped
(temporary) exposure they contribute to.

For example, if the instrument has a mosaic camera, each group would
consist of the subset of CCD exposures from a single camera exposure
that potentially overlap the patch.

@return Struct with:
- groups: Dict of <group tuple>: <list of data references for group>
- keys: List of keys for group tuple

Definition at line 60 of file coaddHelpers.py.

60  tempExpDatasetType="deepCoadd_directWarp"):
61  """Group calibrated exposures overlapping a patch by the warped
62  (temporary) exposure they contribute to.
63 
64  For example, if the instrument has a mosaic camera, each group would
65  consist of the subset of CCD exposures from a single camera exposure
66  that potentially overlap the patch.
67 
68  @return Struct with:
69  - groups: Dict of <group tuple>: <list of data references for group>
70  - keys: List of keys for group tuple
71  """
72  butler = patchDataRef.getButler()
73  tempExpKeys = butler.getKeys(datasetType=tempExpDatasetType)
74  coaddKeys = sorted(butler.getKeys(datasetType=coaddDatasetType))
75  keys = sorted(set(tempExpKeys) - set(coaddKeys)) # Keys that will specify an exposure
76  patchId = patchDataRef.dataId
77  groups = groupDataRefs(keys, calexpDataRefList)
78 
79  # Supplement the groups with the coadd-specific information (e.g., tract, patch; these are constant)
80  coaddValues = tuple(patchId[k] for k in coaddKeys)
81  groups = dict((k + coaddValues, v) for k, v in groups.items())
82  keys += tuple(coaddKeys)
83 
84  return Struct(groups=groups, keys=keys)
85 
86 
daf::base::PropertySet * set
Definition: fits.cc:884
def groupDataRefs(keys, dataRefIterable)
Definition: coaddHelpers.py:35