lsst.meas.algorithms  13.0-23-gb99accf8+4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask Class Reference

Abstract base class to load objects from reference catalogs. More...

Inheritance diagram for lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask:

Public Member Functions

def __init__
 Construct a LoadReferenceObjectsTask. More...
 
def loadPixelBox
 Load reference objects that overlap a pixel-based rectangular region. More...
 
def loadSkyCircle
 Load reference objects that overlap a circular sky region. More...
 
def getMetadataBox
 Return metadata about the load. More...
 
def getMetadataCircle
 Return metadata about the load. More...
 
def joinMatchListWithCatalog
 Relink an unpersisted match list to sources and reference objects. More...
 

Static Public Member Functions

def makeMinimalSchema
 Make the standard schema for reference object catalogs. More...
 

Public Attributes

 butler
 

Static Public Attributes

 ConfigClass = LoadReferenceObjectsConfig
 

Detailed Description

Abstract base class to load objects from reference catalogs.

Contents

Description

Abstract base class for tasks that load objects from a reference catalog in a particular region of the sky.

Implementations must subclass this class, override the loadSkyCircle method, and will typically override the value of ConfigClass with a task-specific config class.

Task initialisation

Construct a LoadReferenceObjectsTask.

Parameters
[in]butlerA daf.persistence.Butler object. This allows subclasses to use the butler to access reference catalog files using the stack I/O abstraction scheme.

Invoking the Task

Schema of the reference object catalog

Reference object catalogs are instances of lsst.afw.table.SimpleCatalog with the following schema (other fields may also be present):

Configuration parameters

See LoadReferenceObjectsConfig for a base set of configuration parameters. Most subclasses will add configuration variables.

Definition at line 119 of file loadReferenceObjects.py.

Constructor & Destructor Documentation

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.__init__ (   self,
  butler = None,
  args,
  kwargs 
)

Construct a LoadReferenceObjectsTask.

Parameters
[in]butlerA daf.persistence.Butler object. This allows subclasses to use the butler to access reference catalog files using the stack I/O abstraction scheme.

Definition at line 178 of file loadReferenceObjects.py.

Member Function Documentation

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataBox (   self,
  bbox,
  wcs,
  filterName = None,
  calib = None 
)

Return metadata about the load.

This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list.

Parameters
[in]bboxbounding box for pixels (an lsst.afw.geom.Box2I or Box2D)
[in]wcsWCS (an lsst.afw.image.Wcs)
[in]filterNamename of camera filter, or None or blank for the default filter
[in]calibcalibration, or None if unknown
Returns
metadata (lsst.daf.base.PropertyList)

Definition at line 377 of file loadReferenceObjects.py.

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataCircle (   self,
  coord,
  radius,
  filterName,
  calib = None 
)

Return metadata about the load.

This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list.

Parameters
[in]coordcentral coordinate of circle (lsst.afw.coord.Coord)
[in]radiusradius of circle (lsst.afw.geom.Angle)
[in]filterNamename of camera filter, or None or blank for the default filter
[in]calibcalibration, or None if unknown
Returns
metadata (lsst.daf.base.PropertyList)

Definition at line 392 of file loadReferenceObjects.py.

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.joinMatchListWithCatalog (   self,
  matchCat,
  sourceCat 
)

Relink an unpersisted match list to sources and reference objects.

A match list is persisted and unpersisted as a catalog of IDs produced by afw.table.packMatches(), with match metadata (as returned by the astrometry tasks) in the catalog's metadata attribute. This method converts such a match catalog into a match list (an lsst.afw.table.ReferenceMatchVector) with links to source records and reference object records.

Parameters
[in]matchCatUnperisted packed match list (an lsst.afw.table.BaseCatalog). matchCat.table.getMetadata() must contain match metadata, as returned by the astrometry tasks.
[in,out]sourceCatSource catalog (an lsst.afw.table.SourceCatalog). As a side effect, the catalog will be sorted by ID.
Returns
the match list (an lsst.afw.table.ReferenceMatchVector)

Definition at line 413 of file loadReferenceObjects.py.

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadPixelBox (   self,
  bbox,
  wcs,
  filterName = None,
  calib = None 
)

Load reference objects that overlap a pixel-based rectangular region.

The search algorithm works by searching in a region in sky coordinates whose center is the center of the bbox and radius is large enough to just include all 4 corners of the bbox. Stars that lie outside the bbox are then trimmed from the list.

Parameters
[in]bboxbounding box for pixels (an lsst.afw.geom.Box2I or Box2D)
[in]wcsWCS (an lsst.afw.image.Wcs)
[in]filterNamename of camera filter, or None or blank for the default filter
[in]calibcalibration, or None if unknown
Returns
an lsst.pipe.base.Struct containing:
  • refCat a catalog of reference objects with the standard schema as documented in LoadReferenceObjects, including photometric, resolved and variable; hasCentroid is False for all objects.
  • fluxField = name of flux field for specified filterName

Definition at line 188 of file loadReferenceObjects.py.

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadSkyCircle (   self,
  ctrCoord,
  radius,
  filterName = None 
)

Load reference objects that overlap a circular sky region.

Parameters
[in]ctrCoordcenter of search region (an lsst.afw.geom.Coord)
[in]radiusradius of search region (an lsst.afw.geom.Angle)
[in]filterNamename of filter, or None for the default filter; used for flux values in case we have flux limits (which are not yet implemented)
Returns
an lsst.pipe.base.Struct containing:
  • refCat a catalog of reference objects with the standard schema as documented in LoadReferenceObjects, including photometric, resolved and variable; hasCentroid is False for all objects.
  • fluxField = name of flux field for specified filterName

Definition at line 226 of file loadReferenceObjects.py.

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.makeMinimalSchema (   filterNameList,
  addFluxSigma = False,
  addIsPhotometric = False,
  addIsResolved = False,
  addIsVariable = False 
)
static

Make the standard schema for reference object catalogs.

Parameters
[in]filterNameListlist of filter names; used to create filterName_flux fields
[in]addFluxSigmaif True then include flux sigma fields
[in]addIsPhotometricif True add field "photometric"
[in]addIsResolvedif True add field "resolved"
[in]addIsVariableif True add field "variable"

Definition at line 305 of file loadReferenceObjects.py.

Member Data Documentation

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.butler

Definition at line 185 of file loadReferenceObjects.py.

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.ConfigClass = LoadReferenceObjectsConfig
static

Definition at line 175 of file loadReferenceObjects.py.


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