lsst.meas.base.references.CoaddSrcReferencesTask Class Reference

Inheritance diagram for lsst.meas.base.references.CoaddSrcReferencesTask:

Public Member Functions
def	__init__ (self, butler=None, schema=None, **kwargs)
def	getWcs (self, dataRef)
def	fetchInPatches (self, dataRef, patchList)
def	fetchInBox (self, dataRef, bbox, wcs, pad=0)

Public Attributes
	schema

Static Public Attributes
	ConfigClass = CoaddSrcReferencesConfig
string	datasetSuffix = "src"

Detailed Description

Select reference sources by loading the “coadd source” dataset directly.

The name of the dataset to read is generated by appending the
`datasetSuffix` attribute to the string ``Coadd_``. The dataset is then
read directly from disk using the Butler.

Parameters
----------
schema : `lsst.afw.table.Schema`, optional
    The schema of the detection catalogs used as input to this one.
butler : `lsst.daf.persistence.butler.Butler`, optional
    A Butler used to read the input schema from disk. Required if
    ``schema`` is `None`.

Notes
-----
The task will set its own ``self.schema`` attribute to the schema of the
output merged catalog.

Definition at line 236 of file references.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.base.references.CoaddSrcReferencesTask.__init__	(		self,
			butler = None,
			schema = None,
		**	kwargs
	)

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

Definition at line 265 of file references.py.

Member Function Documentation

fetchInBox()

def lsst.meas.base.references.CoaddSrcReferencesTask.fetchInBox	(		self,
			dataRef,
			bbox,
			wcs,
			pad = 0
	)

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.

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

Definition at line 329 of file references.py.

fetchInPatches()

def lsst.meas.base.references.CoaddSrcReferencesTask.fetchInPatches	(		self,
			dataRef,
			patchList
	)

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.

getWcs()

def lsst.meas.base.references.CoaddSrcReferencesTask.getWcs	(		self,
			dataRef
	)

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.

Member Data Documentation

ConfigClass

lsst.meas.base.references.CoaddSrcReferencesTask.ConfigClass = CoaddSrcReferencesConfig

static

Definition at line 257 of file references.py.

datasetSuffix

string lsst.meas.base.references.CoaddSrcReferencesTask.datasetSuffix = "src"

static

Definition at line 261 of file references.py.

schema

lsst.meas.base.references.CoaddSrcReferencesTask.schema

Definition at line 271 of file references.py.

---

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

• python/lsst/meas/base/references.py