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

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

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

def	getMetadataCircle (self, coord, radius, filterName, photoCalib=None, epoch=None)

def	joinMatchListWithCatalog (self, matchCat, sourceCat)

def	applyProperMotions (self, catalog, epoch)

Static Public Member Functions
def	makeMinimalSchema (filterNameList, addCentroid=True, addIsPhotometric=False, addIsResolved=False, addIsVariable=False, coordErrDim=2, addProperMotion=False, properMotionErrDim=2, addParallax=False, addParallaxErr=True)

Public Attributes
	andConfig

	haveIndexFiles

	multiInds

	butler

Static Public Attributes
	ConfigClass = LoadAstrometryNetObjectsConfig

Detailed Description

Load reference objects from astrometry.net index files.

Description

Load reference objects from astrometry.net index files.

Task initialisation

Create a LoadAstrometryNetObjectsTask.

Parameters

[in]	config	configuration (an instance of self.ConfigClass); if None use self.ConfigClass()
[in]	andConfig	astrometry.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]	kwargs	additional keyword arguments for pipe_base Task.__init__

Exceptions

RuntimeError if 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 A complete example of using PhotoCalTask.

Debug variables

LoadAstrometryNetObjectsTask does not support any debug variables.

Definition at line 24 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]	config	configuration (an instance of self.ConfigClass); if None use self.ConfigClass()
[in]	andConfig	astrometry.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]	kwargs	additional keyword arguments for pipe_base Task.__init__

Exceptions

RuntimeError if 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 67 of file loadAstrometryNetObjects.py.

     def __init__(self, config=None, andConfig=None, **kwargs):
         """!Create a LoadAstrometryNetObjectsTask
 
         @param[in] config  configuration (an instance of self.ConfigClass); if None use self.ConfigClass()
         @param[in] andConfig  astrometry.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)
         @param[in] kwargs  additional keyword arguments for pipe_base Task.\_\_init\_\_
 
         @throw RuntimeError if 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"
         """
         LoadReferenceObjectsTask.__init__(self, config=config, **kwargs)
         self.andConfig = andConfig
         self.haveIndexFiles = False  # defer reading index files until we know they are needed
         # because astrometry may not be used, in which case it may not be properly configured
 

Member Function Documentation

◆ applyProperMotions()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.applyProperMotions	(	self,
		catalog,
		epoch
	)

inherited

Apply proper motion correction to a reference catalog.

Adjust position and position error in the ``catalog``
for proper motion to the specified ``epoch``,
modifying the catalong in place.

Parameters
----------
catalog : `lsst.afw.table.SimpleCatalog`
    Catalog of positions, containing:

    - Coordinates, retrieved by the table's coordinate key.
    - ``coord_raErr`` : Error in Right Ascension (rad).
    - ``coord_decErr`` : Error in Declination (rad).
    - ``pm_ra`` : Proper motion in Right Ascension (rad/yr,
East positive)
    - ``pm_raErr`` : Error in ``pm_ra`` (rad/yr), optional.
    - ``pm_dec`` : Proper motion in Declination (rad/yr,
North positive)
    - ``pm_decErr`` : Error in ``pm_dec`` (rad/yr), optional.
    - ``epoch`` : Mean epoch of object (an astropy.time.Time)
epoch : `astropy.time.Time` (optional)
    Epoch to which to correct proper motion and parallax,
    or None to not apply such corrections.

Definition at line 1362 of file loadReferenceObjects.py.

     def applyProperMotions(self, catalog, epoch):
         """Apply proper motion correction to a reference catalog.
 
         Adjust position and position error in the ``catalog``
         for proper motion to the specified ``epoch``,
         modifying the catalong in place.
 
         Parameters
         ----------
         catalog : `lsst.afw.table.SimpleCatalog`
             Catalog of positions, containing:
 
             - Coordinates, retrieved by the table's coordinate key.
             - ``coord_raErr`` : Error in Right Ascension (rad).
             - ``coord_decErr`` : Error in Declination (rad).
             - ``pm_ra`` : Proper motion in Right Ascension (rad/yr,
                 East positive)
             - ``pm_raErr`` : Error in ``pm_ra`` (rad/yr), optional.
             - ``pm_dec`` : Proper motion in Declination (rad/yr,
                 North positive)
             - ``pm_decErr`` : Error in ``pm_dec`` (rad/yr), optional.
             - ``epoch`` : Mean epoch of object (an astropy.time.Time)
         epoch : `astropy.time.Time` (optional)
             Epoch to which to correct proper motion and parallax,
             or None to not apply such corrections.
         """
         if ("epoch" not in catalog.schema or "pm_ra" not in catalog.schema or "pm_dec" not in catalog.schema):
             if self.config.requireProperMotion:
                 raise RuntimeError("Proper motion correction required but not available from catalog")
             self.log.warn("Proper motion correction not available from catalog")
             return
         applyProperMotionsImpl(self.log, catalog, epoch)
 
 

◆ getMetadataBox()

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

inherited

Return metadata about the load.

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

Parameters
----------
bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
    Pixel bounding box.
wcs : `lsst.afw.geom.SkyWcs`
    WCS; used to convert pixel positions to sky coordinates.
filterName : `str`
    Name of camera filter, or `None` or `""` for the default
    filter.
photoCalib : `lsst.afw.image.PhotoCalib` (optional)
    Calibration, or `None` if unknown.
epoch : `astropy.time.Time` (optional)
    Epoch to which to correct proper motion and parallax,
    or None to not apply such corrections.

Returns
-------
metadata : lsst.daf.base.PropertyList
    Metadata about the load.

Definition at line 1270 of file loadReferenceObjects.py.

     def getMetadataBox(self, bbox, wcs, filterName=None, photoCalib=None, epoch=None):
         """Return metadata about the load.
 
         This metadata is used for reloading the catalog (e.g., for
         reconstituting a normalised match list.
 
         Parameters
         ----------
         bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
             Pixel bounding box.
         wcs : `lsst.afw.geom.SkyWcs`
             WCS; used to convert pixel positions to sky coordinates.
         filterName : `str`
             Name of camera filter, or `None` or `""` for the default
             filter.
         photoCalib : `lsst.afw.image.PhotoCalib` (optional)
             Calibration, or `None` if unknown.
         epoch : `astropy.time.Time` (optional)
             Epoch to which to correct proper motion and parallax,
             or None to not apply such corrections.
 
         Returns
         -------
         metadata : lsst.daf.base.PropertyList
             Metadata about the load.
         """
         circle = self._calculateCircle(bbox, wcs)
         return self.getMetadataCircle(circle.coord, circle.radius, filterName, photoCalib)
 

◆ getMetadataCircle()

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

inherited

Return metadata about the load.

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

Parameters
----------
coord : `lsst.geom.SpherePoint`
    ICRS center of the search region.
radius : `lsst.geom.Angle`
    Radius of the search region.
filterName : `str`
    Name of camera filter, or `None` or `""` for the default
    filter.
photoCalib : `lsst.afw.image.PhotoCalib` (optional)
    Calibration, or `None` if unknown.
epoch : `astropy.time.Time` (optional)
    Epoch to which to correct proper motion and parallax,
    or None to not apply such corrections.

Returns
-------
metadata : lsst.daf.base.PropertyList
    Metadata about the load

Definition at line 1299 of file loadReferenceObjects.py.

     def getMetadataCircle(self, coord, radius, filterName, photoCalib=None, epoch=None):
         """Return metadata about the load.
 
         This metadata is used for reloading the catalog (e.g., for
         reconstituting a normalised match list.
 
         Parameters
         ----------
         coord : `lsst.geom.SpherePoint`
             ICRS center of the search region.
         radius : `lsst.geom.Angle`
             Radius of the search region.
         filterName : `str`
             Name of camera filter, or `None` or `""` for the default
             filter.
         photoCalib : `lsst.afw.image.PhotoCalib` (optional)
             Calibration, or `None` if unknown.
         epoch : `astropy.time.Time` (optional)
             Epoch to which to correct proper motion and parallax,
             or None to not apply such corrections.
 
         Returns
         -------
         metadata : lsst.daf.base.PropertyList
             Metadata about the load
         """
         md = PropertyList()
         md.add('RA', coord.getRa().asDegrees(), 'field center in degrees')
         md.add('DEC', coord.getDec().asDegrees(), 'field center in degrees')
         md.add('RADIUS', radius.asDegrees(), 'field radius in degrees, minimum')
         md.add('SMATCHV', 1, 'SourceMatchVector version number')
         filterName = "UNKNOWN" if filterName is None else str(filterName)
         md.add('FILTER', filterName, 'filter name for photometric data')
         md.add('EPOCH', "NONE" if epoch is None else epoch, 'Epoch (TAI MJD) for catalog')
         return md
 

◆ joinMatchListWithCatalog()

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

inherited

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, with links to source records and reference object records.

Parameters
----------
matchCat : `lsst.afw.table.BaseCatalog`
    Unperisted packed match list.
    ``matchCat.table.getMetadata()`` must contain match metadata,
    as returned by the astrometry tasks.
sourceCat : `lsst.afw.table.SourceCatalog`
    Source catalog. As a side effect, the catalog will be sorted
    by ID.

Returns
-------
matchList : `lsst.afw.table.ReferenceMatchVector`
    Match list.

Definition at line 1335 of file loadReferenceObjects.py.

     def 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, with links to source records and reference object records.
 
         Parameters
         ----------
         matchCat : `lsst.afw.table.BaseCatalog`
             Unperisted packed match list.
             ``matchCat.table.getMetadata()`` must contain match metadata,
             as returned by the astrometry tasks.
         sourceCat : `lsst.afw.table.SourceCatalog`
             Source catalog. As a side effect, the catalog will be sorted
             by ID.
 
         Returns
         -------
         matchList : `lsst.afw.table.ReferenceMatchVector`
             Match list.
         """
         return joinMatchListWithCatalogImpl(self, matchCat, sourceCat)
 

◆ loadPixelBox()

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

inherited

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, or `None` or `""` for the default filter.
    This is used for flux values in case we have flux limits
    (which are not yet implemented).
photoCalib : `lsst.afw.image.PhotoCalib` (optional)
    Calibration, or `None` if unknown.
epoch : `astropy.time.Time` (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 901 of file loadReferenceObjects.py.

     def loadPixelBox(self, bbox, wcs, filterName=None, 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, or `None` or `""` for the default filter.
             This is used for flux values in case we have flux limits
             (which are not yet implemented).
         photoCalib : `lsst.afw.image.PhotoCalib` (optional)
             Calibration, or `None` if unknown.
         epoch : `astropy.time.Time` (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.
         """
         circle = self._calculateCircle(bbox, wcs)
 
         # find objects in circle
         self.log.info("Loading reference objects using center %s and radius %s deg" %
                       (circle.coord, circle.radius.asDegrees()))
         loadRes = self.loadSkyCircle(circle.coord, circle.radius, filterName)
         refCat = loadRes.refCat
         numFound = len(refCat)
 
         # trim objects outside bbox
         refCat = self._trimToBBox(refCat=refCat, bbox=circle.bbox, wcs=wcs)
         numTrimmed = numFound - len(refCat)
         self.log.debug("trimmed %d out-of-bbox objects, leaving %d", numTrimmed, len(refCat))
         self.log.info("Loaded %d reference objects", len(refCat))
 
         # make sure catalog is contiguous
         if not refCat.isContiguous():
             loadRes.refCat = refCat.copy(deep=True)
 
         return loadRes
 

◆ 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]	ctrCoord	center of search region (an afwGeom.Coord)
[in]	radius	radius of search region (an afwGeom.Angle)
[in]	filterName	name of filter, or None for the default filter; used for flux values in case we have flux limits (which are not yet implemented)
[in]	epoch	Epoch 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 85 of file loadAstrometryNetObjects.py.

     def loadSkyCircle(self, ctrCoord, radius, filterName=None, epoch=None):
         """!Load reference objects that overlap a circular sky region
 
         @param[in] ctrCoord  center of search region (an afwGeom.Coord)
         @param[in] radius  radius of search region (an afwGeom.Angle)
         @param[in] filterName  name of filter, or None for the default filter;
             used for flux values in case we have flux limits (which are not yet implemented)
         @param[in] epoch  Epoch 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.
 
         @return an lsst.pipe.base.Struct containing:
         - refCat a catalog of reference objects with the
             \link meas_algorithms_loadReferenceObjects_Schema standard schema \endlink
             as documented in LoadReferenceObjects, including photometric, resolved and variable;
             hasCentroid is False for all objects.
         - fluxField = name of flux field for specified filterName
         """
         self._readIndexFiles()
 
         names = []
         mcols = []
         ecols = []
         for col, mcol in self.andConfig.magColumnMap.items():
             names.append(col)
             mcols.append(mcol)
             ecols.append(self.andConfig.magErrorColumnMap.get(col, ''))
         margs = (names, mcols, ecols)
 
         solver = self._getSolver()
 
         # Find multi-index files within range
         multiInds = self._getMIndexesWithinRange(ctrCoord, radius)
 
         # compute solver.getCatalog arguments that follow the list of star kd-trees:
         # - center equatorial angle (e.g. RA) in deg
         # - center polar angle (e.g. Dec) in deg
         # - radius, in deg
         # - idColumn
         # - (margs)
         # - star-galaxy column
         # - variability column
         fixedArgTuple = (
             ctrCoord,
             radius,
             self.andConfig.idColumn,
         ) + margs + (
             self.andConfig.starGalaxyColumn,
             self.andConfig.variableColumn,
             True,  # eliminate duplicate IDs
         )
 
         self.log.debug("search for objects at %s with radius %s deg", ctrCoord, radius.asDegrees())
         with LoadMultiIndexes(multiInds):
             # We just want to pass the star kd-trees, so just pass the
             # first element of each multi-index.
             inds = tuple(mi[0] for mi in multiInds)
             refCat = solver.getCatalog(inds, *fixedArgTuple)
 
         self._addFluxAliases(schema=refCat.schema)
 
         fluxField = getRefFluxField(schema=refCat.schema, filterName=filterName)
 
         # NOTE: sourceSelectors require contiguous catalogs, so ensure
         # contiguity now, so views are preserved from here on.
         if not refCat.isContiguous():
             refCat = refCat.copy(deep=True)
 
         # Update flux fields to be nJy. a.net catalogs do not have a conversion script.
         self.log.warn("Loading A.net reference catalog with old style units in schema.")
         self.log.warn("A.net reference catalogs will not be supported in the future.")
         self.log.warn("See RFC-562 and RFC-575 for more details.")
         refCat = convertToNanojansky(refCat, self.log)
 
         self.log.debug("found %d objects", len(refCat))
         return pipeBase.Struct(
             refCat=refCat,
             fluxField=fluxField,
         )
 

◆ makeMinimalSchema()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.makeMinimalSchema	(	filterNameList,
		addCentroid = `True`,
		addIsPhotometric = `False`,
		addIsResolved = `False`,
		addIsVariable = `False`,
		coordErrDim = `2`,
		addProperMotion = `False`,
		properMotionErrDim = `2`,
		addParallax = `False`,
		addParallaxErr = `True`
	)

staticinherited

Make a standard schema for reference object catalogs.

Parameters
----------
filterNameList : `list` of `str`
    List of filter names. Used to create <filterName>_flux fields.
addIsPhotometric : `bool`
    If True then add field "photometric".
addIsResolved : `bool`
    If True then add field "resolved".
addIsVariable : `bool`
    If True then add field "variable".
coordErrDim : `int`
    Number of coord error fields; must be one of 0, 2, 3:

    - If 2 or 3: add fields "coord_raErr" and "coord_decErr".
    - If 3: also add field "coord_radecErr".
addProperMotion : `bool`
    If True add fields "epoch", "pm_ra", "pm_dec" and "pm_flag".
properMotionErrDim : `int`
    Number of proper motion error fields; must be one of 0, 2, 3;
    ignored if addProperMotion false:
    - If 2 or 3: add fields "pm_raErr" and "pm_decErr".
    - If 3: also add field "pm_radecErr".
addParallax : `bool`
    If True add fields "epoch", "parallax", "parallaxErr"
    and "parallax_flag".
addParallaxErr : `bool`
    If True add field "parallaxErr"; ignored if addParallax false.

Returns
-------
schema : `lsst.afw.table.Schema`
    Schema for reference catalog, an
    `lsst.afw.table.SimpleCatalog`.

Notes
-----
Reference catalogs support additional covariances, such as
covariance between RA and proper motion in declination,
that are not supported by this method, but can be added after
calling this method.

Definition at line 1084 of file loadReferenceObjects.py.

                           addParallax=False, addParallaxErr=True):
         """Make a standard schema for reference object catalogs.
 
         Parameters
         ----------
         filterNameList : `list` of `str`
             List of filter names. Used to create <filterName>_flux fields.
         addIsPhotometric : `bool`
             If True then add field "photometric".
         addIsResolved : `bool`
             If True then add field "resolved".
         addIsVariable : `bool`
             If True then add field "variable".
         coordErrDim : `int`
             Number of coord error fields; must be one of 0, 2, 3:
 
             - If 2 or 3: add fields "coord_raErr" and "coord_decErr".
             - If 3: also add field "coord_radecErr".
         addProperMotion : `bool`
             If True add fields "epoch", "pm_ra", "pm_dec" and "pm_flag".
         properMotionErrDim : `int`
             Number of proper motion error fields; must be one of 0, 2, 3;
             ignored if addProperMotion false:
             - If 2 or 3: add fields "pm_raErr" and "pm_decErr".
             - If 3: also add field "pm_radecErr".
         addParallax : `bool`
             If True add fields "epoch", "parallax", "parallaxErr"
             and "parallax_flag".
         addParallaxErr : `bool`
             If True add field "parallaxErr"; ignored if addParallax false.
 
         Returns
         -------
         schema : `lsst.afw.table.Schema`
             Schema for reference catalog, an
             `lsst.afw.table.SimpleCatalog`.
 
         Notes
         -----
         Reference catalogs support additional covariances, such as
         covariance between RA and proper motion in declination,
         that are not supported by this method, but can be added after
         calling this method.
         """
         schema = afwTable.SimpleTable.makeMinimalSchema()
         if addCentroid:
             afwTable.Point2DKey.addFields(
                 schema,
                 "centroid",
                 "centroid on an exposure, if relevant",
                 "pixel",
             )
             schema.addField(
                 field="hasCentroid",
                 type="Flag",
                 doc="is position known?",
             )
         for filterName in filterNameList:
             schema.addField(
                 field="%s_flux" % (filterName,),
                 type=numpy.float64,
                 doc="flux in filter %s" % (filterName,),
                 units="nJy",
             )
         for filterName in filterNameList:
             schema.addField(
                 field="%s_fluxErr" % (filterName,),
                 type=numpy.float64,
                 doc="flux uncertainty in filter %s" % (filterName,),
                 units="nJy",
             )
         if addIsPhotometric:
             schema.addField(
                 field="photometric",
                 type="Flag",
                 doc="set if the object can be used for photometric calibration",
             )
         if addIsResolved:
             schema.addField(
                 field="resolved",
                 type="Flag",
                 doc="set if the object is spatially resolved",
             )
         if addIsVariable:
             schema.addField(
                 field="variable",
                 type="Flag",
                 doc="set if the object has variable brightness",
             )
         if coordErrDim not in (0, 2, 3):
             raise ValueError("coordErrDim={}; must be (0, 2, 3)".format(coordErrDim))
         if coordErrDim > 0:
             afwTable.CovarianceMatrix2fKey.addFields(
                 schema=schema,
                 prefix="coord",
                 names=["ra", "dec"],
                 units=["rad", "rad"],
                 diagonalOnly=(coordErrDim == 2),
             )
 
         if addProperMotion or addParallax:
             schema.addField(
                 field="epoch",
                 type=numpy.float64,
                 doc="date of observation (TAI, MJD)",
                 units="day",
             )
 
         if addProperMotion:
             schema.addField(
                 field="pm_ra",
                 type="Angle",
                 doc="proper motion in the right ascension direction = dra/dt * cos(dec)",
                 units="rad/year",
             )
             schema.addField(
                 field="pm_dec",
                 type="Angle",
                 doc="proper motion in the declination direction",
                 units="rad/year",
             )
             if properMotionErrDim not in (0, 2, 3):
                 raise ValueError("properMotionErrDim={}; must be (0, 2, 3)".format(properMotionErrDim))
             if properMotionErrDim > 0:
                 afwTable.CovarianceMatrix2fKey.addFields(
                     schema=schema,
                     prefix="pm",
                     names=["ra", "dec"],
                     units=["rad/year", "rad/year"],
                     diagonalOnly=(properMotionErrDim == 2),
                 )
             schema.addField(
                 field="pm_flag",
                 type="Flag",
                 doc="Set if proper motion or proper motion error is bad",
             )
 
         if addParallax:
             schema.addField(
                 field="parallax",
                 type=numpy.float64,
                 doc="parallax",
                 units="rad",
             )
             if addParallaxErr:
                 schema.addField(
                     field="parallaxErr",
                     type=numpy.float64,
                     doc="uncertainty in parallax",
                     units="rad",
                 )
             schema.addField(
                 field="parallax_flag",
                 type="Flag",
                 doc="Set if parallax or parallax error is bad",
             )
         return schema
 

Member Data Documentation

◆ andConfig

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

Definition at line 80 of file loadAstrometryNetObjects.py.

◆ butler

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.butler

inherited

Definition at line 898 of file loadReferenceObjects.py.

◆ ConfigClass

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

static

Definition at line 65 of file loadAstrometryNetObjects.py.

◆ haveIndexFiles

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

Definition at line 81 of file loadAstrometryNetObjects.py.

◆ multiInds

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

Definition at line 183 of file loadAstrometryNetObjects.py.

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

/j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_astrometryNet/18.1.0/python/lsst/meas/extensions/astrometryNet/loadAstrometryNetObjects.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Contents

Description

Task initialisation

Invoking the Task

Configuration parameters

A complete example of using

Debug variables

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ applyProperMotions()

◆ getMetadataBox()

◆ getMetadataCircle()

◆ joinMatchListWithCatalog()

◆ loadPixelBox()

◆ loadSkyCircle()

◆ makeMinimalSchema()

Member Data Documentation

◆ andConfig

◆ butler

◆ ConfigClass

◆ haveIndexFiles

◆ multiInds

◆ init()