lsst.meas.extensions.astrometryNet  16.0-8-g21fd5fe+37
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask Class Reference

Load reference objects from astrometry.net index files. More...

Inheritance diagram for lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask:

Public Member Functions

def __init__ (self, config=None, andConfig=None, kwargs)
 Create a LoadAstrometryNetObjectsTask. More...
 
def loadSkyCircle (self, ctrCoord, radius, filterName=None, epoch=None)
 Load reference objects that overlap a circular sky region. More...
 

Public Attributes

 andConfig
 
 haveIndexFiles
 
 multiInds
 

Static Public Attributes

 ConfigClass = LoadAstrometryNetObjectsConfig
 

Detailed Description

Load reference objects from astrometry.net index files.

Contents

Description

Load reference objects from astrometry.net index files.

Task initialisation

Create a LoadAstrometryNetObjectsTask.

Parameters
[in]configconfiguration (an instance of self.ConfigClass); if None use self.ConfigClass()
[in]andConfigastrometry.net data config (an instance of AstromNetDataConfig, or None); if None then use andConfig.py in the astrometry_net_data product (which must be setup)
[in]kwargsadditional keyword arguments for pipe_base Task.__init__
Exceptions
RuntimeErrorif andConfig is None and the configuration cannot be found, either because astrometry_net_data is not setup in eups or because the setup version does not include the file "andConfig.py"

Invoking the Task

Configuration parameters

See LoadAstrometryNetObjectsConfig

A complete example of using

LoadAstrometryNetObjectsTask

LoadAstrometryNetObjectsTask is a subtask of AstrometryTask, which is called by PhotoCalTask. See pipe_tasks_photocal_Example.

Debug variables

LoadAstrometryNetObjectsTask does not support any debug variables.

Definition at line 23 of file loadAstrometryNetObjects.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask.__init__ (   self,
  config = None,
  andConfig = None,
  kwargs 
)

Create a LoadAstrometryNetObjectsTask.

Parameters
[in]configconfiguration (an instance of self.ConfigClass); if None use self.ConfigClass()
[in]andConfigastrometry.net data config (an instance of AstromNetDataConfig, or None); if None then use andConfig.py in the astrometry_net_data product (which must be setup)
[in]kwargsadditional keyword arguments for pipe_base Task.__init__
Exceptions
RuntimeErrorif andConfig is None and the configuration cannot be found, either because astrometry_net_data is not setup in eups or because the setup version does not include the file "andConfig.py"

Definition at line 66 of file loadAstrometryNetObjects.py.

Member Function Documentation

◆ loadSkyCircle()

def lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask.loadSkyCircle (   self,
  ctrCoord,
  radius,
  filterName = None,
  epoch = None 
)

Load reference objects that overlap a circular sky region.

Parameters
[in]ctrCoordcenter of search region (an afwGeom.Coord)
[in]radiusradius of search region (an afwGeom.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)
[in]epochEpoch for proper motion and parallax correction (an astropy.time.Time), or None

No proper motion correction is made, since our astrometry.net catalogs typically don't support that, and even if they do they format is uncertain. Users interested in proper motion corrections should use the lsst.meas.algorithms.LoadIndexedReferenceObjectsTask or they will need to subclass and define how the proper motion correction is to be done.

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 84 of file loadAstrometryNetObjects.py.

Member Data Documentation

◆ andConfig

lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask.andConfig

Definition at line 79 of file loadAstrometryNetObjects.py.

◆ ConfigClass

lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask.ConfigClass = LoadAstrometryNetObjectsConfig
static

Definition at line 64 of file loadAstrometryNetObjects.py.

◆ haveIndexFiles

lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask.haveIndexFiles

Definition at line 80 of file loadAstrometryNetObjects.py.

◆ multiInds

lsst.meas.extensions.astrometryNet.loadAstrometryNetObjects.LoadAstrometryNetObjectsTask.multiInds

Definition at line 176 of file loadAstrometryNetObjects.py.


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