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

Public Member Functions

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

Public Attributes

 refObjLoader
 
 refCatName
 

Static Public Attributes

 ConfigClass = FgcmLoadReferenceCatalogConfig
 

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__()

def 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

◆ getFgcmReferenceStarsHealpix()

def 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()

def 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

◆ 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: