lsst.meas.algorithms  13.0-18-gc4ad4228
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

Public Member Functions

def __init__ (self, butler, args, kwargs)
 
def loadSkyCircle (self, ctrCoord, radius, filterName=None)
 Load reference objects that overlap a circular sky region. More...
 
def get_shards (self, id_list)
 Get all shards that touch a circular aperture. More...
 
- Public Member Functions inherited from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask
def __init__ (self, butler=None, args, kwargs)
 Construct a LoadReferenceObjectsTask. More...
 
def loadPixelBox (self, bbox, wcs, filterName=None, calib=None)
 Load reference objects that overlap a pixel-based rectangular region. More...
 
def loadSkyCircle (self, ctrCoord, radius, filterName=None)
 Load reference objects that overlap a circular sky region. More...
 
def joinMatchListWithCatalog (self, matchCat, sourceCat)
 Relink an unpersisted match list to sources and reference objects. More...
 

Public Attributes

 indexer
 
 ref_dataset_name
 
 butler
 
- Public Attributes inherited from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask
 butler
 

Static Public Attributes

 ConfigClass = LoadIndexedReferenceObjectsConfig
 
- Static Public Attributes inherited from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask
 ConfigClass = LoadReferenceObjectsConfig
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask
def makeMinimalSchema (filterNameList, addFluxSigma=False, addIsPhotometric=False, addIsResolved=False, addIsVariable=False)
 Make the standard schema for reference object catalogs. More...
 

Detailed Description

Definition at line 44 of file loadIndexedReferenceObjects.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.__init__ (   self,
  butler,
  args,
  kwargs 
)

Definition at line 48 of file loadIndexedReferenceObjects.py.

Member Function Documentation

◆ get_shards()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.get_shards (   self,
  id_list 
)

Get all shards that touch a circular aperture.

Parameters
[in]id_listA list of integer pixel ids
[out]alist of SourceCatalogs for each pixel, None if not data exists

Definition at line 110 of file loadIndexedReferenceObjects.py.

◆ loadSkyCircle()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.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. None if refCat is None.

Definition at line 58 of file loadIndexedReferenceObjects.py.

Member Data Documentation

◆ butler

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.butler

Definition at line 55 of file loadIndexedReferenceObjects.py.

◆ ConfigClass

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

Definition at line 45 of file loadIndexedReferenceObjects.py.

◆ indexer

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.indexer

Definition at line 51 of file loadIndexedReferenceObjects.py.

◆ ref_dataset_name

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.ref_dataset_name

Definition at line 54 of file loadIndexedReferenceObjects.py.


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