lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.references.CoaddSrcReferencesTask Class Reference

A references task implementation that loads the coadd_datasetSuffix dataset directly from disk using the butler. More...

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

Public Member Functions

def __init__
 Initialize the task. More...
 
def getWcs
 
def fetchInPatches
 An implementation of BaseReferencesTask.fetchInPatches that loads 'coadd_' + datasetSuffix catalogs using the butler. More...
 
def fetchInBox
 Return reference sources that overlap a region defined by a pixel-coordinate bounding box and corresponding Wcs. More...
 
- Public Member Functions inherited from lsst.meas.base.references.BaseReferencesTask
def __init__
 Initialize the task. More...
 
def getSchema
 Return the schema for the reference sources. More...
 
def getWcs
 Return the WCS for reference sources. More...
 
def fetchInBox
 Return reference sources that overlap a region defined by a pixel-coordinate bounding box and corresponding Wcs. More...
 
def fetchInPatches
 Return reference sources that overlap a region defined by one or more SkyMap patches. More...
 
def subset
 Filter sources to contain only those within the given box, defined in the coordinate system defined by the given Wcs. More...
 

Public Attributes

 schema
 

Static Public Attributes

 ConfigClass = CoaddSrcReferencesConfig
 
string datasetSuffix = "src"
 
- Static Public Attributes inherited from lsst.meas.base.references.BaseReferencesTask
 ConfigClass = BaseReferencesConfig
 

Detailed Description

A references task implementation that loads the coadd_datasetSuffix dataset directly from disk using the butler.

Definition at line 179 of file references.py.

Constructor & Destructor Documentation

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

Initialize the task.

Additional keyword arguments (forwarded to BaseReferencesTask.__init__):

  • schema: the schema of the detection catalogs used as input to this one
  • butler: a butler used to read the input schema from disk, if schema is None The task will set its own self.schema attribute to the schema of the output merged catalog.

Definition at line 188 of file references.py.

Member Function Documentation

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

Return reference sources that overlap a region defined by a pixel-coordinate bounding box and corresponding Wcs.

Parameters
[in]dataRefButlerDataRef; the implied data ID must contain the 'tract' key.
[in]bboxa afw.geom.Box2I or Box2D that defines the region in pixel coordinates
[in]wcsafw.image.Wcs that maps the bbox to sky coordinates
[in]pada buffer to grow the bounding box by after catalogs have been loaded, but before filtering them to include just the given bounding box.
Returns
an iterable of reference sources

Definition at line 238 of file references.py.

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

An implementation of BaseReferencesTask.fetchInPatches that loads 'coadd_' + datasetSuffix catalogs using the butler.

The given dataRef must include the tract in its dataId.

Definition at line 208 of file references.py.

def lsst.meas.base.references.CoaddSrcReferencesTask.getWcs (   self,
  dataRef 
)
Return the WCS for reference sources.  The given dataRef must include the tract in its dataId.

Definition at line 202 of file references.py.

Member Data Documentation

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

Definition at line 185 of file references.py.

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

Definition at line 186 of file references.py.

lsst.meas.base.references.CoaddSrcReferencesTask.schema

Definition at line 200 of file references.py.


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