LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask Class Reference
Inheritance diagram for lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask:

Public Member Functions

def __init__ (self, dataIds=None, refCats=None, butler=None, **kwargs)
 
def getPixelBoxCatalog (self, bbox, wcs, filterList, epoch=None, bboxToSpherePadding=None)
 
def getSkyCircleCatalog (self, center, radius, filterList, epoch=None, catalogFormat='numpy')
 

Public Attributes

 refObjLoader
 

Static Public Attributes

 ConfigClass = LoadReferenceCatalogConfig
 

Detailed Description

Load multi-band reference objects from a reference catalog.

Parameters
----------
dataIds : iterable of `lsst.daf.butler.dataId`, optional
    An iterable object of dataIds which point to reference catalogs
    in a Gen3 repository.  Required for Gen3.
refCats : iterable of `lsst.daf.butler.DeferredDatasetHandle`, optional
    An iterable object of dataset refs for reference catalogs in
    a Gen3 repository.  Required for Gen3.
butler : `lsst.daf.persistence.Butler`, optional
    A Gen2 butler.  Required for Gen2.

Definition at line 77 of file loadReferenceCatalog.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.__init__ (   self,
  dataIds = None,
  refCats = None,
  butler = None,
**  kwargs 
)

Definition at line 94 of file loadReferenceCatalog.py.

94  def __init__(self, dataIds=None, refCats=None, butler=None, **kwargs):
95  if dataIds is not None and refCats is not None:
96  pipeBase.Task.__init__(self, **kwargs)
97  refConfig = self.config.refObjLoader
98  self.refObjLoader = ReferenceObjectLoader(dataIds=dataIds,
99  refCats=refCats,
100  config=refConfig,
101  log=self.log)
102  elif butler is not None:
103  raise RuntimeError("LoadReferenceCatalogTask does not support Gen2 Butlers.")
104  else:
105  raise RuntimeError("Must instantiate LoadReferenceCatalogTask with "
106  "dataIds and refCats (Gen3)")
107 
108  if self.config.doReferenceSelection:
109  self.makeSubtask('referenceSelector')
110  self._fluxFilters = None
111  self._fluxFields = None
112  self._referenceFilter = None
113 

Member Function Documentation

◆ getPixelBoxCatalog()

def lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.getPixelBoxCatalog (   self,
  bbox,
  wcs,
  filterList,
  epoch = None,
  bboxToSpherePadding = None 
) 
Get a multi-band reference catalog by specifying a bounding box and WCS.

The catalog will be in `numpy.ndarray`, with positions proper-motion
corrected to "epoch" (if specified, and if the reference catalog has
proper motions); sources cut on a reference selector (if
"config.doReferenceSelection = True"); and color-terms applied (if
"config.doApplyColorTerms = True").

The format of the reference catalog will be of the format:

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

Reference magnitudes (AB) and errors will be 99 for non-detections
in a given band.

Parameters
----------
bbox : `lsst.geom.Box2I`
    Box which bounds a region in pixel space.
wcs : `lsst.afw.geom.SkyWcs`
    Wcs object defining the pixel to sky (and reverse) transform for
    the supplied bbox.
filterList : `List` [ `str` ]
    List of camera physicalFilter names to retrieve magnitudes.
epoch : `astropy.time.Time`, optional
    Epoch to which to correct proper motion and parallax
    (if available), or `None` to not apply such corrections.
bboxToSpherePadding : `int`, optional
    Padding to account for translating a set of corners into a
    spherical (convex) boundary that is certain to encompass the
    entire area covered by the bbox.

Returns
-------
refCat : `numpy.ndarray`
    Reference catalog.

Definition at line 114 of file loadReferenceCatalog.py.

115  bboxToSpherePadding=None):
116  """Get a multi-band reference catalog by specifying a bounding box and WCS.
117 
118  The catalog will be in `numpy.ndarray`, with positions proper-motion
119  corrected to "epoch" (if specified, and if the reference catalog has
120  proper motions); sources cut on a reference selector (if
121  "config.doReferenceSelection = True"); and color-terms applied (if
122  "config.doApplyColorTerms = True").
123 
124  The format of the reference catalog will be of the format:
125 
126  dtype = [('ra', 'np.float64'),
127  ('dec', 'np.float64'),
128  ('refMag', 'np.float32', (len(filterList), )),
129  ('refMagErr', 'np.float32', (len(filterList), ))]
130 
131  Reference magnitudes (AB) and errors will be 99 for non-detections
132  in a given band.
133 
134  Parameters
135  ----------
136  bbox : `lsst.geom.Box2I`
137  Box which bounds a region in pixel space.
138  wcs : `lsst.afw.geom.SkyWcs`
139  Wcs object defining the pixel to sky (and reverse) transform for
140  the supplied bbox.
141  filterList : `List` [ `str` ]
142  List of camera physicalFilter names to retrieve magnitudes.
143  epoch : `astropy.time.Time`, optional
144  Epoch to which to correct proper motion and parallax
145  (if available), or `None` to not apply such corrections.
146  bboxToSpherePadding : `int`, optional
147  Padding to account for translating a set of corners into a
148  spherical (convex) boundary that is certain to encompass the
149  entire area covered by the bbox.
150 
151  Returns
152  -------
153  refCat : `numpy.ndarray`
154  Reference catalog.
155  """
156  # Check if we have previously cached values for the fluxFields
157  if self._fluxFilters is None or self._fluxFilters != filterList:
158  center = wcs.pixelToSky(bbox.getCenter())
159  self._determineFluxFields(center, filterList)
160 
161  skyBox = self.refObjLoader.loadPixelBox(bbox, wcs, self._referenceFilter,
162  epoch=epoch,
163  bboxToSpherePadding=bboxToSpherePadding)
164 
165  if not skyBox.refCat.isContiguous():
166  refCat = skyBox.refCat.copy(deep=True)
167  else:
168  refCat = skyBox.refCat
169 
170  return self._formatCatalog(refCat, filterList)
171 

◆ getSkyCircleCatalog()

def lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.getSkyCircleCatalog (   self,
  center,
  radius,
  filterList,
  epoch = None,
  catalogFormat = 'numpy' 
) 
Get a multi-band reference catalog by specifying a center and radius.

The catalog will be in `numpy.ndarray`, with positions proper-motion
corrected to "epoch" (if specified, and if the reference catalog has
proper motions); sources cut on a reference selector (if
"config.doReferenceSelection = True"); and color-terms applied (if
"config.doApplyColorTerms = True").

The format of the reference catalog will be of the format:

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

Reference magnitudes (AB) and errors will be 99 for non-detections
in a given band.

Parameters
----------
center : `lsst.geom.SpherePoint`
    Point defining the center of the circular region.
radius : `lsst.geom.Angle`
    Defines the angular radius of the circular region.
filterList : `List` [ `str` ]
    List of camera physicalFilter names to retrieve magnitudes.
epoch : `astropy.time.Time`, optional
    Epoch to which to correct proper motion and parallax
    (if available), or `None` to not apply such corrections.

Parameters
----------
refCat : `numpy.ndarray`
    Reference catalog.

Definition at line 172 of file loadReferenceCatalog.py.

173  catalogFormat='numpy'):
174  """Get a multi-band reference catalog by specifying a center and radius.
175 
176  The catalog will be in `numpy.ndarray`, with positions proper-motion
177  corrected to "epoch" (if specified, and if the reference catalog has
178  proper motions); sources cut on a reference selector (if
179  "config.doReferenceSelection = True"); and color-terms applied (if
180  "config.doApplyColorTerms = True").
181 
182  The format of the reference catalog will be of the format:
183 
184  dtype = [('ra', 'np.float64'),
185  ('dec', 'np.float64'),
186  ('refMag', 'np.float32', (len(filterList), )),
187  ('refMagErr', 'np.float32', (len(filterList), ))]
188 
189  Reference magnitudes (AB) and errors will be 99 for non-detections
190  in a given band.
191 
192  Parameters
193  ----------
194  center : `lsst.geom.SpherePoint`
195  Point defining the center of the circular region.
196  radius : `lsst.geom.Angle`
197  Defines the angular radius of the circular region.
198  filterList : `List` [ `str` ]
199  List of camera physicalFilter names to retrieve magnitudes.
200  epoch : `astropy.time.Time`, optional
201  Epoch to which to correct proper motion and parallax
202  (if available), or `None` to not apply such corrections.
203 
204  Parameters
205  ----------
206  refCat : `numpy.ndarray`
207  Reference catalog.
208  """
209  # Check if we have previously cached values for the fluxFields
210  if self._fluxFilters is None or self._fluxFilters != filterList:
211  self._determineFluxFields(center, filterList)
212 
213  skyCircle = self.refObjLoader.loadSkyCircle(center, radius,
214  self._referenceFilter,
215  epoch=epoch)
216 
217  if not skyCircle.refCat.isContiguous():
218  refCat = skyCircle.refCat.copy(deep=True)
219  else:
220  refCat = skyCircle.refCat
221 
222  return self._formatCatalog(refCat, filterList)
223 

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.ConfigClass = LoadReferenceCatalogConfig
static

Definition at line 91 of file loadReferenceCatalog.py.

◆ refObjLoader

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.refObjLoader

Definition at line 98 of file loadReferenceCatalog.py.

The documentation for this class was generated from the following file:
Generated on Fri Nov 26 2021 10:16:28 for LSST Applications by doxygen 1.9.1