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

Public Member Functions
def	__init__ (self, butler=None, args, *kwargs)

def	loadPixelBox (self, bbox, wcs, filterName, photoCalib=None, epoch=None)

def	loadSkyCircle (self, ctrCoord, radius, filterName, epoch=None, centroids=False)

Public Attributes
	butler

Detailed Description

Abstract gen2 base class to load objects from reference catalogs.

Definition at line 1100 of file loadReferenceObjects.py.

Constructor & Destructor Documentation

◆ init()

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

Construct a LoadReferenceObjectsTask

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler, for access reference catalogs.

Reimplemented from lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoaderBase.

Reimplemented in lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.

Definition at line 1105 of file loadReferenceObjects.py.

Member Function Documentation

◆ loadPixelBox()

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

Load reference objects that overlap a rectangular pixel region.

Parameters
----------
bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
    Bounding box for pixels.
wcs : `lsst.afw.geom.SkyWcs`
    WCS; used to convert pixel positions to sky coordinates
    and vice-versa.
filterName : `str`
    Name of filter. This can be used for flux limit comparisons.
photoCalib : `None`
    Deprecated, only included for api compatibility.
epoch : `astropy.time.Time` or `None`, optional
    Epoch to which to correct proper motion and parallax, or `None` to
    not apply such corrections.

Returns
-------
results : `lsst.pipe.base.Struct`
    A Struct containing the following fields:
    refCat : `lsst.afw.catalog.SimpleCatalog`
        A catalog of reference objects with the standard
        schema, as documented in the main doc string for
        `LoadReferenceObjects`.
        The catalog is guaranteed to be contiguous.
    fluxField : `str`
        Name of flux field for specified `filterName`.

Notes
-----
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.

Definition at line 1117 of file loadReferenceObjects.py.

◆ loadSkyCircle()

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

Load reference objects that overlap a circular sky region.

Parameters
----------
ctrCoord : `lsst.geom.SpherePoint`
    ICRS center of search region.
radius : `lsst.geom.Angle`
    Radius of search region.
filterName : `str`
    Name of filter. This can be used for flux limit comparisons.
epoch : `astropy.time.Time` or `None`, optional
    Epoch to which to correct proper motion and parallax, or `None` to
    not apply such corrections.
centroids : `bool`, optional
    Add centroid fields to the loaded Schema. ``loadPixelBox`` expects
    these fields to exist.

Returns
-------
results : `lsst.pipe.base.Struct`
    A Struct containing the following fields:
    refCat : `lsst.afw.catalog.SimpleCatalog`
        A catalog of reference objects with the standard
        schema, as documented in the main doc string for
        `LoadReferenceObjects`.
        The catalog is guaranteed to be contiguous.
    fluxField : `str`
        Name of flux field for specified `filterName`.

Notes
-----
Note that subclasses are responsible for performing the proper motion
correction, since this is the lowest-level interface for retrieving
the catalog.

Reimplemented in lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.

Definition at line 1177 of file loadReferenceObjects.py.

Member Data Documentation

◆ butler

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.butler

Definition at line 1114 of file loadReferenceObjects.py.

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

python/lsst/meas/algorithms/loadReferenceObjects.py

Public Member Functions

Public Attributes