lsst.meas.algorithms g3d2f48815b+b48d7c3842
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask Class Reference
Inheritance diagram for lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask:
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoaderBase

Public Member Functions

def __init__ (self, butler, *args, **kwargs)
 
def loadSkyCircle (self, ctrCoord, radius, filterName, epoch=None, centroids=False)
 
def getShards (self, shardIdList)
 

Public Attributes

 dataset_config
 
 indexer
 
 ref_dataset_name
 
 butler
 

Static Public Attributes

 ConfigClass = LoadIndexedReferenceObjectsConfig
 

Detailed Description

Load reference objects from an indexed catalog ingested by
IngestIndexReferenceTask.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler for reading catalogs

Definition at line 42 of file loadIndexedReferenceObjects.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.__init__ (   self,
  butler,
args,
**  kwargs 
)
Construct a LoadReferenceObjectsTask

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

Reimplemented from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.

Definition at line 54 of file loadIndexedReferenceObjects.py.

Member Function Documentation

◆ getShards()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.getShards (   self,
  shardIdList 
)
Get shards by ID.

Parameters
----------
shardIdList : `list` of `int`
    A list of integer shard ids.

Returns
-------
catalogs : `list` of `lsst.afw.table.SimpleCatalog`
    A list of reference catalogs, one for each entry in shardIdList.

Definition at line 113 of file loadIndexedReferenceObjects.py.

◆ loadSkyCircle()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.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 from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.

Definition at line 64 of file loadIndexedReferenceObjects.py.

Member Data Documentation

◆ butler

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.butler

Definition at line 61 of file loadIndexedReferenceObjects.py.

◆ ConfigClass

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.ConfigClass = LoadIndexedReferenceObjectsConfig
static

Definition at line 51 of file loadIndexedReferenceObjects.py.

◆ dataset_config

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.dataset_config

Definition at line 56 of file loadIndexedReferenceObjects.py.

◆ indexer

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.indexer

Definition at line 57 of file loadIndexedReferenceObjects.py.

◆ ref_dataset_name

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.ref_dataset_name

Definition at line 60 of file loadIndexedReferenceObjects.py.


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