LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.references.MultiBandReferencesTask Class Reference
Inheritance diagram for lsst.meas.base.references.MultiBandReferencesTask:
lsst.meas.base.references.CoaddSrcReferencesTask lsst.meas.base.references.BaseReferencesTask lsst.pipe.base.task.Task

Public Member Functions

def getWcs (self, dataRef)
 
def fetchInPatches (self, dataRef, patchList)
 
def fetchInBox (self, dataRef, bbox, wcs, pad=0)
 
def fetchInBox (self, dataRef, bbox, wcs)
 
def getSchema (self, butler)
 
def subset (self, sources, bbox, wcs)
 
def emptyMetadata (self)
 
def getSchemaCatalogs (self)
 
def getAllSchemaCatalogs (self)
 
def getFullMetadata (self)
 
def getFullName (self)
 
def getName (self)
 
def getTaskDict (self)
 
def makeSubtask (self, name, **keyArgs)
 
def timer (self, name, logLevel=Log.DEBUG)
 
def makeField (cls, doc)
 
def __reduce__ (self)
 

Public Attributes

 schema
 
 metadata
 
 log
 
 config
 

Static Public Attributes

 ConfigClass = MultiBandReferencesConfig
 
string datasetSuffix = "ref"
 

Detailed Description

Loads references from the multi-band processing scheme.

Definition at line 381 of file references.py.

Member Function Documentation

◆ __reduce__()

def lsst.pipe.base.task.Task.__reduce__ (   self)
inherited
Pickler.

Reimplemented in lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, and lsst.pipe.drivers.coaddDriver.CoaddDriverTask.

Definition at line 432 of file task.py.

432  def __reduce__(self):
433  """Pickler.
434  """
435  return self._unpickle_via_factory, (self.__class__, [], self._reduce_kwargs())

◆ emptyMetadata()

def lsst.pipe.base.task.Task.emptyMetadata (   self)
inherited
Empty (clear) the metadata for this Task and all sub-Tasks.

Definition at line 166 of file task.py.

166  def emptyMetadata(self):
167  """Empty (clear) the metadata for this Task and all sub-Tasks.
168  """
169  for subtask in self._taskDict.values():
170  subtask.metadata = dafBase.PropertyList()
171 
Class for storing ordered metadata with comments.
Definition: PropertyList.h:68

◆ fetchInBox() [1/2]

def lsst.meas.base.references.BaseReferencesTask.fetchInBox (   self,
  dataRef,
  bbox,
  wcs 
)
inherited
Return reference sources within a given bounding box.

Reference sources are selected if they overlap a region defined by a
pixel-coordinate bounding box and corresponding WCS.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The implied data ID must contain the
    ``tract`` key.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
    Defines the selection region in pixel coordinates.
wcs : `lsst.afw.image.SkyWcs`
    Maps ``bbox`` to sky coordinates.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.

Notes
-----
The returned set of sources should be complete and close to minimal.

Definition at line 108 of file references.py.

108  def fetchInBox(self, dataRef, bbox, wcs):
109  """Return reference sources within a given bounding box.
110 
111  Reference sources are selected if they overlap a region defined by a
112  pixel-coordinate bounding box and corresponding WCS.
113 
114  Parameters
115  ----------
116  dataRef : `lsst.daf.persistence.ButlerDataRef`
117  Butler data reference. The implied data ID must contain the
118  ``tract`` key.
119  bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
120  Defines the selection region in pixel coordinates.
121  wcs : `lsst.afw.image.SkyWcs`
122  Maps ``bbox`` to sky coordinates.
123 
124  Returns
125  -------
126  sources : iterable of `~lsst.afw.table.SourceRecord`
127  Reference sources. May be any Python iterable, including a lazy
128  iterator.
129 
130  Notes
131  -----
132  The returned set of sources should be complete and close to minimal.
133  """
134  raise NotImplementedError("BaseReferencesTask is pure abstract, and cannot be used directly.")
135 

◆ fetchInBox() [2/2]

def lsst.meas.base.references.CoaddSrcReferencesTask.fetchInBox (   self,
  dataRef,
  bbox,
  wcs,
  pad = 0 
)
inherited
Return reference sources within a given bounding box.

Reference sources are selected if they overlap a region defined by a
pixel-coordinate bounding box and corresponding WCS.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The implied data ID must contain the
    ``tract`` key.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
    Defines the selection region in pixel coordinates.
wcs : `lsst.afw.image.SkyWcs`
    Maps ``bbox`` to sky coordinates.
pad : `int`
    a buffer to grow the bounding box by after catalogs have been loaded, but
    before filtering them to include just the given bounding box.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.

Definition at line 329 of file references.py.

329  def fetchInBox(self, dataRef, bbox, wcs, pad=0):
330  """Return reference sources within a given bounding box.
331 
332  Reference sources are selected if they overlap a region defined by a
333  pixel-coordinate bounding box and corresponding WCS.
334 
335  Parameters
336  ----------
337  dataRef : `lsst.daf.persistence.ButlerDataRef`
338  Butler data reference. The implied data ID must contain the
339  ``tract`` key.
340  bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
341  Defines the selection region in pixel coordinates.
342  wcs : `lsst.afw.image.SkyWcs`
343  Maps ``bbox`` to sky coordinates.
344  pad : `int`
345  a buffer to grow the bounding box by after catalogs have been loaded, but
346  before filtering them to include just the given bounding box.
347 
348  Returns
349  -------
350  sources : iterable of `~lsst.afw.table.SourceRecord`
351  Reference sources. May be any Python iterable, including a lazy
352  iterator.
353  """
354  skyMap = dataRef.get(self.config.coaddName + "Coadd_skyMap", immediate=True)
355  tract = skyMap[dataRef.dataId["tract"]]
356  coordList = [wcs.pixelToSky(corner) for corner in lsst.geom.Box2D(bbox).getCorners()]
357  self.log.info("Getting references in region with corners %s [degrees]" %
358  ", ".join("(%s)" % (coord.getPosition(lsst.geom.degrees),) for coord in coordList))
359  patchList = tract.findPatchList(coordList)
360  # After figuring out which patch catalogs to read from the bbox, pad out the bbox if desired
361  # But don't add any new patches while padding
362  if pad:
363  bbox.grow(pad)
364  return self.subset(self.fetchInPatches(dataRef, patchList), bbox, wcs)
365 
366 
A floating-point coordinate rectangle geometry.
Definition: Box.h:413

◆ fetchInPatches()

def lsst.meas.base.references.CoaddSrcReferencesTask.fetchInPatches (   self,
  dataRef,
  patchList 
)
inherited
Fetch the source catalog using the Butler.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The implied data ID must contain the
    ``tract`` key.
patchList : `list` of `lsst.skymap.PatchInfo`
    Patches for which to fetch reference sources.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.

Notes
-----
An implementation of `BaseReferencesTask.fetchInPatches` that loads
``Coadd_`` + `datasetSuffix` catalogs using the butler.

Reimplemented from lsst.meas.base.references.BaseReferencesTask.

Definition at line 284 of file references.py.

284  def fetchInPatches(self, dataRef, patchList):
285  """Fetch the source catalog using the Butler.
286 
287  Parameters
288  ----------
289  dataRef : `lsst.daf.persistence.ButlerDataRef`
290  Butler data reference. The implied data ID must contain the
291  ``tract`` key.
292  patchList : `list` of `lsst.skymap.PatchInfo`
293  Patches for which to fetch reference sources.
294 
295  Returns
296  -------
297  sources : iterable of `~lsst.afw.table.SourceRecord`
298  Reference sources. May be any Python iterable, including a lazy
299  iterator.
300 
301  Notes
302  -----
303  An implementation of `BaseReferencesTask.fetchInPatches` that loads
304  ``Coadd_`` + `datasetSuffix` catalogs using the butler.
305  """
306  dataset = "{}Coadd_{}".format(self.config.coaddName, self.datasetSuffix)
307  tract = dataRef.dataId["tract"]
308  butler = dataRef.butlerSubset.butler
309  for patch in patchList:
310  dataId = {'tract': tract, 'patch': "%d,%d" % patch.getIndex()}
311  if self.config.filter is not None:
312  dataId['filter'] = self.config.filter
313 
314  if not butler.datasetExists(dataset, dataId):
315  if self.config.skipMissing:
316  continue
317  raise lsst.pipe.base.TaskError("Reference %s doesn't exist" % (dataId,))
318  self.log.info("Getting references in %s" % (dataId,))
319  catalog = butler.get(dataset, dataId, immediate=True)
320  if self.config.removePatchOverlaps:
321  bbox = lsst.geom.Box2D(patch.getInnerBBox())
322  for source in catalog:
323  if bbox.contains(source.getCentroid()):
324  yield source
325  else:
326  for source in catalog:
327  yield source
328 
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ getAllSchemaCatalogs()

def lsst.pipe.base.task.Task.getAllSchemaCatalogs (   self)
inherited
Get schema catalogs for all tasks in the hierarchy, combining the
results into a single dict.

Returns
-------
schemacatalogs : `dict`
    Keys are butler dataset type, values are a empty catalog (an
    instance of the appropriate `lsst.afw.table` Catalog type) for all
    tasks in the hierarchy, from the top-level task down
    through all subtasks.

Notes
-----
This method may be called on any task in the hierarchy; it will return
the same answer, regardless.

The default implementation should always suffice. If your subtask uses
schemas the override `Task.getSchemaCatalogs`, not this method.

Definition at line 204 of file task.py.

204  def getAllSchemaCatalogs(self):
205  """Get schema catalogs for all tasks in the hierarchy, combining the
206  results into a single dict.
207 
208  Returns
209  -------
210  schemacatalogs : `dict`
211  Keys are butler dataset type, values are a empty catalog (an
212  instance of the appropriate `lsst.afw.table` Catalog type) for all
213  tasks in the hierarchy, from the top-level task down
214  through all subtasks.
215 
216  Notes
217  -----
218  This method may be called on any task in the hierarchy; it will return
219  the same answer, regardless.
220 
221  The default implementation should always suffice. If your subtask uses
222  schemas the override `Task.getSchemaCatalogs`, not this method.
223  """
224  schemaDict = self.getSchemaCatalogs()
225  for subtask in self._taskDict.values():
226  schemaDict.update(subtask.getSchemaCatalogs())
227  return schemaDict
228 

◆ getFullMetadata()

def lsst.pipe.base.task.Task.getFullMetadata (   self)
inherited
Get metadata for all tasks.

Returns
-------
metadata : `lsst.daf.base.PropertySet`
    The `~lsst.daf.base.PropertySet` keys are the full task name.
    Values are metadata for the top-level task and all subtasks,
    sub-subtasks, etc.

Notes
-----
The returned metadata includes timing information (if
``@timer.timeMethod`` is used) and any metadata set by the task. The
name of each item consists of the full task name with ``.`` replaced
by ``:``, followed by ``.`` and the name of the item, e.g.::

    topLevelTaskName:subtaskName:subsubtaskName.itemName

using ``:`` in the full task name disambiguates the rare situation
that a task has a subtask and a metadata item with the same name.

Definition at line 229 of file task.py.

229  def getFullMetadata(self):
230  """Get metadata for all tasks.
231 
232  Returns
233  -------
234  metadata : `lsst.daf.base.PropertySet`
235  The `~lsst.daf.base.PropertySet` keys are the full task name.
236  Values are metadata for the top-level task and all subtasks,
237  sub-subtasks, etc.
238 
239  Notes
240  -----
241  The returned metadata includes timing information (if
242  ``@timer.timeMethod`` is used) and any metadata set by the task. The
243  name of each item consists of the full task name with ``.`` replaced
244  by ``:``, followed by ``.`` and the name of the item, e.g.::
245 
246  topLevelTaskName:subtaskName:subsubtaskName.itemName
247 
248  using ``:`` in the full task name disambiguates the rare situation
249  that a task has a subtask and a metadata item with the same name.
250  """
251  fullMetadata = dafBase.PropertySet()
252  for fullName, task in self.getTaskDict().items():
253  fullMetadata.set(fullName.replace(".", ":"), task.metadata)
254  return fullMetadata
255 
std::vector< SchemaItem< Flag > > * items
Class for storing generic metadata.
Definition: PropertySet.h:67

◆ getFullName()

def lsst.pipe.base.task.Task.getFullName (   self)
inherited
Get the task name as a hierarchical name including parent task
names.

Returns
-------
fullName : `str`
    The full name consists of the name of the parent task and each
    subtask separated by periods. For example:

    - The full name of top-level task "top" is simply "top".
    - The full name of subtask "sub" of top-level task "top" is
      "top.sub".
    - The full name of subtask "sub2" of subtask "sub" of top-level
      task "top" is "top.sub.sub2".

Definition at line 256 of file task.py.

256  def getFullName(self):
257  """Get the task name as a hierarchical name including parent task
258  names.
259 
260  Returns
261  -------
262  fullName : `str`
263  The full name consists of the name of the parent task and each
264  subtask separated by periods. For example:
265 
266  - The full name of top-level task "top" is simply "top".
267  - The full name of subtask "sub" of top-level task "top" is
268  "top.sub".
269  - The full name of subtask "sub2" of subtask "sub" of top-level
270  task "top" is "top.sub.sub2".
271  """
272  return self._fullName
273 

◆ getName()

def lsst.pipe.base.task.Task.getName (   self)
inherited
Get the name of the task.

Returns
-------
taskName : `str`
    Name of the task.

See also
--------
getFullName

Definition at line 274 of file task.py.

274  def getName(self):
275  """Get the name of the task.
276 
277  Returns
278  -------
279  taskName : `str`
280  Name of the task.
281 
282  See also
283  --------
284  getFullName
285  """
286  return self._name
287 
std::string const & getName() const noexcept
Return a filter's name.
Definition: Filter.h:78

◆ getSchema()

def lsst.meas.base.references.BaseReferencesTask.getSchema (   self,
  butler 
)
inherited
Return the schema for the reference sources.

Parameters
----------
butler : `lsst.daf.persistence.butler.Butler`
    Data butler from which the schema will be fetched.

Notes
-----
Must be available even before any data has been processed.

Definition at line 83 of file references.py.

83  def getSchema(self, butler):
84  """Return the schema for the reference sources.
85 
86  Parameters
87  ----------
88  butler : `lsst.daf.persistence.butler.Butler`
89  Data butler from which the schema will be fetched.
90 
91  Notes
92  -----
93  Must be available even before any data has been processed.
94  """
95  raise NotImplementedError("BaseReferencesTask is pure abstract, and cannot be used directly.")
96 

◆ getSchemaCatalogs()

def lsst.pipe.base.task.Task.getSchemaCatalogs (   self)
inherited
Get the schemas generated by this task.

Returns
-------
schemaCatalogs : `dict`
    Keys are butler dataset type, values are an empty catalog (an
    instance of the appropriate `lsst.afw.table` Catalog type) for
    this task.

Notes
-----

.. warning::

   Subclasses that use schemas must override this method. The default
   implementation returns an empty dict.

This method may be called at any time after the Task is constructed,
which means that all task schemas should be computed at construction
time, *not* when data is actually processed. This reflects the
philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g.
slots for SourceCatalog as well.

See also
--------
Task.getAllSchemaCatalogs

Definition at line 172 of file task.py.

172  def getSchemaCatalogs(self):
173  """Get the schemas generated by this task.
174 
175  Returns
176  -------
177  schemaCatalogs : `dict`
178  Keys are butler dataset type, values are an empty catalog (an
179  instance of the appropriate `lsst.afw.table` Catalog type) for
180  this task.
181 
182  Notes
183  -----
184 
185  .. warning::
186 
187  Subclasses that use schemas must override this method. The default
188  implementation returns an empty dict.
189 
190  This method may be called at any time after the Task is constructed,
191  which means that all task schemas should be computed at construction
192  time, *not* when data is actually processed. This reflects the
193  philosophy that the schema should not depend on the data.
194 
195  Returning catalogs rather than just schemas allows us to save e.g.
196  slots for SourceCatalog as well.
197 
198  See also
199  --------
200  Task.getAllSchemaCatalogs
201  """
202  return {}
203 

◆ getTaskDict()

def lsst.pipe.base.task.Task.getTaskDict (   self)
inherited
Get a dictionary of all tasks as a shallow copy.

Returns
-------
taskDict : `dict`
    Dictionary containing full task name: task object for the top-level
    task and all subtasks, sub-subtasks, etc.

Definition at line 288 of file task.py.

288  def getTaskDict(self):
289  """Get a dictionary of all tasks as a shallow copy.
290 
291  Returns
292  -------
293  taskDict : `dict`
294  Dictionary containing full task name: task object for the top-level
295  task and all subtasks, sub-subtasks, etc.
296  """
297  return self._taskDict.copy()
298 
def getTaskDict(config, taskDict=None, baseName="")

◆ getWcs()

def lsst.meas.base.references.CoaddSrcReferencesTask.getWcs (   self,
  dataRef 
)
inherited
Return the WCS for reference sources.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. Must includ the trac in its dataId.

Reimplemented from lsst.meas.base.references.BaseReferencesTask.

Definition at line 273 of file references.py.

273  def getWcs(self, dataRef):
274  """Return the WCS for reference sources.
275 
276  Parameters
277  ----------
278  dataRef : `lsst.daf.persistence.ButlerDataRef`
279  Butler data reference. Must includ the trac in its dataId.
280  """
281  skyMap = dataRef.get(self.config.coaddName + "Coadd_skyMap", immediate=True)
282  return skyMap[dataRef.dataId["tract"]].getWcs()
283 

◆ makeField()

def lsst.pipe.base.task.Task.makeField (   cls,
  doc 
)
inherited
Make a `lsst.pex.config.ConfigurableField` for this task.

Parameters
----------
doc : `str`
    Help text for the field.

Returns
-------
configurableField : `lsst.pex.config.ConfigurableField`
    A `~ConfigurableField` for this task.

Examples
--------
Provides a convenient way to specify this task is a subtask of another
task.

Here is an example of use:

.. code-block:: python

    class OtherTaskConfig(lsst.pex.config.Config):
        aSubtask = ATaskClass.makeField("brief description of task")

Definition at line 359 of file task.py.

359  def makeField(cls, doc):
360  """Make a `lsst.pex.config.ConfigurableField` for this task.
361 
362  Parameters
363  ----------
364  doc : `str`
365  Help text for the field.
366 
367  Returns
368  -------
369  configurableField : `lsst.pex.config.ConfigurableField`
370  A `~ConfigurableField` for this task.
371 
372  Examples
373  --------
374  Provides a convenient way to specify this task is a subtask of another
375  task.
376 
377  Here is an example of use:
378 
379  .. code-block:: python
380 
381  class OtherTaskConfig(lsst.pex.config.Config):
382  aSubtask = ATaskClass.makeField("brief description of task")
383  """
384  return ConfigurableField(doc=doc, target=cls)
385 

◆ makeSubtask()

def lsst.pipe.base.task.Task.makeSubtask (   self,
  name,
**  keyArgs 
)
inherited
Create a subtask as a new instance as the ``name`` attribute of this
task.

Parameters
----------
name : `str`
    Brief name of the subtask.
keyArgs
    Extra keyword arguments used to construct the task. The following
    arguments are automatically provided and cannot be overridden:

    - "config".
    - "parentTask".

Notes
-----
The subtask must be defined by ``Task.config.name``, an instance of
`~lsst.pex.config.ConfigurableField` or
`~lsst.pex.config.RegistryField`.

Definition at line 299 of file task.py.

299  def makeSubtask(self, name, **keyArgs):
300  """Create a subtask as a new instance as the ``name`` attribute of this
301  task.
302 
303  Parameters
304  ----------
305  name : `str`
306  Brief name of the subtask.
307  keyArgs
308  Extra keyword arguments used to construct the task. The following
309  arguments are automatically provided and cannot be overridden:
310 
311  - "config".
312  - "parentTask".
313 
314  Notes
315  -----
316  The subtask must be defined by ``Task.config.name``, an instance of
317  `~lsst.pex.config.ConfigurableField` or
318  `~lsst.pex.config.RegistryField`.
319  """
320  taskField = getattr(self.config, name, None)
321  if taskField is None:
322  raise KeyError(f"{self.getFullName()}'s config does not have field {name!r}")
323  subtask = taskField.apply(name=name, parentTask=self, **keyArgs)
324  setattr(self, name, subtask)
325 

◆ subset()

def lsst.meas.base.references.BaseReferencesTask.subset (   self,
  sources,
  bbox,
  wcs 
)
inherited
Filter a list of sources to only those within the bounding box.

Parameters
----------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
    Defines the selection region.
wcs : `lsst.afw.image.SkyWcs`
    Maps ``bbox`` to sky coordinates.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Filtered sources. May be any Python iterable, including a lazy
    iterator.

Notes
-----
Instead of filtering sources directly via their positions, we filter
based on the positions of parent objects, then include or discard all
children based on their parent's status. This is necessary to support
replacement with noise in measurement, which requires all child
sources have their parent present.

This is not a part of the required `BaseReferencesTask` interface;
it's a convenience function used in implementing `fetchInBox` that may
be of use to subclasses.

Definition at line 162 of file references.py.

162  def subset(self, sources, bbox, wcs):
163  """Filter a list of sources to only those within the bounding box.
164 
165  Parameters
166  ----------
167  sources : iterable of `~lsst.afw.table.SourceRecord`
168  Reference sources. May be any Python iterable, including a lazy
169  iterator.
170  bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
171  Defines the selection region.
172  wcs : `lsst.afw.image.SkyWcs`
173  Maps ``bbox`` to sky coordinates.
174 
175  Returns
176  -------
177  sources : iterable of `~lsst.afw.table.SourceRecord`
178  Filtered sources. May be any Python iterable, including a lazy
179  iterator.
180 
181  Notes
182  -----
183  Instead of filtering sources directly via their positions, we filter
184  based on the positions of parent objects, then include or discard all
185  children based on their parent's status. This is necessary to support
186  replacement with noise in measurement, which requires all child
187  sources have their parent present.
188 
189  This is not a part of the required `BaseReferencesTask` interface;
190  it's a convenience function used in implementing `fetchInBox` that may
191  be of use to subclasses.
192  """
193  boxD = lsst.geom.Box2D(bbox)
194  # We're passed an arbitrary iterable, but we need a catalog so we can
195  # iterate over parents and then children.
196  catalog = lsst.afw.table.SourceCatalog(self.schema)
197  catalog.extend(sources)
198  # catalog must be sorted by parent ID for lsst.afw.table.getChildren
199  # to work
201  # Iterate over objects that have no parent.
202  parentSources = catalog.getChildren(0)
203  skyCoordList = [source.getCoord() for source in parentSources]
204  pixelPosList = wcs.skyToPixel(skyCoordList)
205  for parent, pixel in zip(parentSources, pixelPosList):
206  if boxD.contains(pixel):
207  yield parent
208  for child in catalog.getChildren(parent.getId()):
209  yield child
210 
211 
static Key< RecordId > getParentKey()
Key for the parent ID.
Definition: Source.h:275

◆ timer()

def lsst.pipe.base.task.Task.timer (   self,
  name,
  logLevel = Log.DEBUG 
)
inherited
Context manager to log performance data for an arbitrary block of
code.

Parameters
----------
name : `str`
    Name of code being timed; data will be logged using item name:
    ``Start`` and ``End``.
logLevel
    A `lsst.log` level constant.

Examples
--------
Creating a timer context:

.. code-block:: python

    with self.timer("someCodeToTime"):
        pass  # code to time

See also
--------
timer.logInfo

Definition at line 327 of file task.py.

327  def timer(self, name, logLevel=Log.DEBUG):
328  """Context manager to log performance data for an arbitrary block of
329  code.
330 
331  Parameters
332  ----------
333  name : `str`
334  Name of code being timed; data will be logged using item name:
335  ``Start`` and ``End``.
336  logLevel
337  A `lsst.log` level constant.
338 
339  Examples
340  --------
341  Creating a timer context:
342 
343  .. code-block:: python
344 
345  with self.timer("someCodeToTime"):
346  pass # code to time
347 
348  See also
349  --------
350  timer.logInfo
351  """
352  logInfo(obj=self, prefix=name + "Start", logLevel=logLevel)
353  try:
354  yield
355  finally:
356  logInfo(obj=self, prefix=name + "End", logLevel=logLevel)
357 
def logInfo(obj, prefix, logLevel=Log.DEBUG)
Definition: timer.py:63

Member Data Documentation

◆ config

lsst.pipe.base.task.Task.config
inherited

Definition at line 162 of file task.py.

◆ ConfigClass

lsst.meas.base.references.MultiBandReferencesTask.ConfigClass = MultiBandReferencesConfig
static

Definition at line 385 of file references.py.

◆ datasetSuffix

string lsst.meas.base.references.MultiBandReferencesTask.datasetSuffix = "ref"
static

Definition at line 386 of file references.py.

◆ log

lsst.pipe.base.task.Task.log
inherited

Definition at line 161 of file task.py.

◆ metadata

lsst.pipe.base.task.Task.metadata
inherited

Definition at line 134 of file task.py.

◆ schema

lsst.meas.base.references.CoaddSrcReferencesTask.schema
inherited

Definition at line 271 of file references.py.


The documentation for this class was generated from the following file: