lsst.fgcmcal g2ab4ef6978+a028ef3590
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask:

Public Member Functions

 __init__ (self, refObjLoader=None, refCatName=None, **kwargs)
 
 getFgcmReferenceStarsHealpix (self, nside, pixel, filterList, nest=False)
 
 getFgcmReferenceStarsSkyCircle (self, ra, dec, radius, filterList)
 

Public Attributes

 refObjLoader
 
 refCatName
 

Static Public Attributes

 ConfigClass = FgcmLoadReferenceCatalogConfig
 

Protected Member Functions

 _determine_flux_fields (self, center, filterList)
 

Protected Attributes

 _fluxFilters
 
 _fluxFields
 
 _referenceFilter
 

Static Protected Attributes

str _DefaultName = 'fgcmLoadReferenceCatalog'
 

Detailed Description

Load multi-band reference objects from a reference catalog.

Parameters
----------
refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`
    Reference object loader.
refCatName : `str`
    Name of reference catalog (for color term lookups).

Definition at line 81 of file fgcmLoadReferenceCatalog.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask.__init__ (   self,
  refObjLoader = None,
  refCatName = None,
**  kwargs 
)
Construct an FgcmLoadReferenceCatalogTask

Definition at line 95 of file fgcmLoadReferenceCatalog.py.

Member Function Documentation

◆ _determine_flux_fields()

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask._determine_flux_fields (   self,
  center,
  filterList 
)
protected
Determine the flux field names for a reference catalog.

Will set self._fluxFields, self._referenceFilter.

Parameters
----------
center: `lsst.geom.SpherePoint`
   The center around which to load test sources.
filterList: `list`
   list of `str` of camera filter names.

Definition at line 273 of file fgcmLoadReferenceCatalog.py.

◆ getFgcmReferenceStarsHealpix()

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask.getFgcmReferenceStarsHealpix (   self,
  nside,
  pixel,
  filterList,
  nest = False 
)
Get a reference catalog that overlaps a healpix pixel, using multiple
filters.  In addition, apply colorterms if available.

Return format is a numpy recarray for use with fgcm, with the format:

dtype = ([('ra', `np.float64`),
          ('dec', `np.float64`),
          ('refMag', `np.float32`, len(filterList)),
          ('refMagErr', `np.float32`, len(filterList)])

Reference magnitudes (AB) will be 99 for non-detections.

Parameters
----------
nside: `int`
   Healpix nside of pixel to load
pixel: `int`
   Healpix pixel of pixel to load
filterList: `list`
   list of `str` of camera filter names.
nest: `bool`, optional
   Is the pixel in nest format?  Default is False.

Returns
-------
fgcmRefCat: `np.recarray`

Definition at line 110 of file fgcmLoadReferenceCatalog.py.

◆ getFgcmReferenceStarsSkyCircle()

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask.getFgcmReferenceStarsSkyCircle (   self,
  ra,
  dec,
  radius,
  filterList 
)
Get a reference catalog that overlaps a circular sky region, using
multiple filters.  In addition, apply colorterms if available.

Return format is a numpy recarray for use with fgcm.

dtype = ([('ra', `np.float64`),
          ('dec', `np.float64`),
          ('refMag', `np.float32`, len(filterList)),
          ('refMagErr', `np.float32`, len(filterList)])

Reference magnitudes (AB) will be 99 for non-detections.

Parameters
----------
ra: `float`
   ICRS right ascension, degrees.
dec: `float`
   ICRS declination, degrees.
radius: `float`
   Radius to search, degrees.
filterList: `list`
   list of `str` of camera filter names.

Returns
-------
fgcmRefCat: `np.recarray`

Definition at line 164 of file fgcmLoadReferenceCatalog.py.

Member Data Documentation

◆ _DefaultName

str lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask._DefaultName = 'fgcmLoadReferenceCatalog'
staticprotected

Definition at line 93 of file fgcmLoadReferenceCatalog.py.

◆ _fluxFields

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask._fluxFields
protected

Definition at line 107 of file fgcmLoadReferenceCatalog.py.

◆ _fluxFilters

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask._fluxFilters
protected

Definition at line 106 of file fgcmLoadReferenceCatalog.py.

◆ _referenceFilter

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask._referenceFilter
protected

Definition at line 108 of file fgcmLoadReferenceCatalog.py.

◆ ConfigClass

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask.ConfigClass = FgcmLoadReferenceCatalogConfig
static

Definition at line 92 of file fgcmLoadReferenceCatalog.py.

◆ refCatName

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask.refCatName

Definition at line 100 of file fgcmLoadReferenceCatalog.py.

◆ refObjLoader

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogTask.refObjLoader

Definition at line 99 of file fgcmLoadReferenceCatalog.py.


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