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
Classes | Functions
lsst.pipe.tasks.multiBandUtils Namespace Reference

Classes

class  MergeSourcesRunner
 
class  CullPeaksConfig
  More...
 

Functions

def makeMergeArgumentParser (name, dataset)
 Create a suitable ArgumentParser. More...
 
def getInputSchema (task, butler=None, schema=None)
 Obtain the input schema either directly or froma butler reference. More...
 
def readCatalog (task, patchRef)
 Read input catalog. More...
 

Function Documentation

◆ getInputSchema()

def lsst.pipe.tasks.multiBandUtils.getInputSchema (   task,
  butler = None,
  schema = None 
)

Obtain the input schema either directly or froma butler reference.

Parameters
[in]butlerbutler reference to obtain the input schema from
[in]schemathe input schema

Definition at line 146 of file multiBandUtils.py.

146 def getInputSchema(task, butler=None, schema=None):
147  """!
148  @brief Obtain the input schema either directly or froma butler reference.
149 
150  @param[in] butler butler reference to obtain the input schema from
151  @param[in] schema the input schema
152  """
153  if schema is None:
154  assert butler is not None, "Neither butler nor schema specified"
155  schema = butler.get(task.config.coaddName + "Coadd_" + task.inputDataset + "_schema",
156  immediate=True).schema
157  return schema
158 
159 
def getInputSchema(task, butler=None, schema=None)
Obtain the input schema either directly or froma butler reference.

◆ makeMergeArgumentParser()

def lsst.pipe.tasks.multiBandUtils.makeMergeArgumentParser (   name,
  dataset 
)

Create a suitable ArgumentParser.

We will use the ArgumentParser to get a provide a list of data references for patches; the RunnerClass will sort them into lists of data references for the same patch

Definition at line 131 of file multiBandUtils.py.

131 def makeMergeArgumentParser(name, dataset):
132  """!
133  @brief Create a suitable ArgumentParser.
134 
135  We will use the ArgumentParser to get a provide a list of data
136  references for patches; the RunnerClass will sort them into lists
137  of data references for the same patch
138  """
139  parser = ArgumentParser(name)
140  parser.add_id_argument("--id", "deepCoadd_" + dataset,
141  ContainerClass=ExistingCoaddDataIdContainer,
142  help="data ID, e.g. --id tract=12345 patch=1,2 filter=g^r^i")
143  return parser
144 
145 
def makeMergeArgumentParser(name, dataset)
Create a suitable ArgumentParser.

◆ readCatalog()

def lsst.pipe.tasks.multiBandUtils.readCatalog (   task,
  patchRef 
)

Read input catalog.

We read the input dataset provided by the 'inputDataset' class variable.

Parameters
[in]patchRefdata reference for patch
Returns
tuple consisting of the band name and the catalog

Definition at line 160 of file multiBandUtils.py.

160 def readCatalog(task, patchRef):
161  """!
162  @brief Read input catalog.
163 
164  We read the input dataset provided by the 'inputDataset'
165  class variable.
166 
167  @param[in] patchRef data reference for patch
168  @return tuple consisting of the band name and the catalog
169  """
170  band = patchRef.get(task.config.coaddName + "Coadd_filterLabel", immediate=True).bandLabel
171  catalog = patchRef.get(task.config.coaddName + "Coadd_" + task.inputDataset, immediate=True)
172  task.log.info("Read %d sources for band %s: %s", len(catalog), band, patchRef.dataId)
173  return band, catalog
174 
175 
def readCatalog(task, patchRef)
Read input catalog.