Inheritance diagram for lsst.pipe.tasks.functors.LocalPhotometry:
Public Member Functions | |
| __init__ (self, instFluxCol, instFluxErrCol, photoCalibCol, photoCalibErrCol, **kwargs) | |
| instFluxToNanojansky (self, instFlux, localCalib) | |
| instFluxErrToNanojanskyErr (self, instFlux, instFluxErr, localCalib, localCalibErr) | |
| instFluxToMagnitude (self, instFlux, localCalib) | |
| instFluxErrToMagnitudeErr (self, instFlux, instFluxErr, localCalib, localCalibErr) | |
Public Attributes | |
| instFluxCol | |
| instFluxErrCol | |
| photoCalibCol | |
| photoCalibErrCol | |
Static Public Attributes | |
| tuple | logNJanskyToAB = (1 * u.nJy).to_value(u.ABmag) |
Detailed Description
Base class for calibrating the specified instrument flux column using
the local photometric calibration.
Parameters
----------
instFluxCol : `str`
Name of the instrument flux column.
instFluxErrCol : `str`
Name of the assocated error columns for ``instFluxCol``.
photoCalibCol : `str`
Name of local calibration column.
photoCalibErrCol : `str`
Error associated with ``photoCalibCol``
See Also
--------
LocalNanojansky
LocalNanojanskyErr
Definition at line 1524 of file functors.py.
Constructor & Destructor Documentation
◆ __init__()
| lsst.pipe.tasks.functors.LocalPhotometry.__init__ | ( | self, | |
| instFluxCol, | |||
| instFluxErrCol, | |||
| photoCalibCol, | |||
| photoCalibErrCol, | |||
| ** | kwargs ) |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Reimplemented in lsst.pipe.tasks.functors.LocalDipoleMeanFlux.
Definition at line 1546 of file functors.py.
1551 **kwargs):
1552 self.instFluxCol = instFluxCol
1553 self.instFluxErrCol = instFluxErrCol
1554 self.photoCalibCol = photoCalibCol
1555 self.photoCalibErrCol = photoCalibErrCol
1556 super().__init__(**kwargs)
1557
Member Function Documentation
◆ instFluxErrToMagnitudeErr()
| lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToMagnitudeErr | ( | self, | |
| instFlux, | |||
| instFluxErr, | |||
| localCalib, | |||
| localCalibErr ) |
Convert instrument flux err to nanojanskys.
Parameters
----------
instFlux : `~numpy.ndarray` or `~pandas.Series`
Array of instrument flux measurements.
instFluxErr : `~numpy.ndarray` or `~pandas.Series`
Errors on associated ``instFlux`` values.
localCalib : `~numpy.ndarray` or `~pandas.Series`
Array of local photometric calibration estimates.
localCalibErr : `~numpy.ndarray` or `~pandas.Series`
Errors on associated ``localCalib`` values.
Returns
-------
calibMagErr: `~numpy.ndarray` or `~pandas.Series`
Error on calibrated AB magnitudes.
Definition at line 1613 of file functors.py.
1613 def instFluxErrToMagnitudeErr(self, instFlux, instFluxErr, localCalib, localCalibErr):
1614 """Convert instrument flux err to nanojanskys.
1615
1616 Parameters
1617 ----------
1618 instFlux : `~numpy.ndarray` or `~pandas.Series`
1619 Array of instrument flux measurements.
1620 instFluxErr : `~numpy.ndarray` or `~pandas.Series`
1621 Errors on associated ``instFlux`` values.
1622 localCalib : `~numpy.ndarray` or `~pandas.Series`
1623 Array of local photometric calibration estimates.
1624 localCalibErr : `~numpy.ndarray` or `~pandas.Series`
1625 Errors on associated ``localCalib`` values.
1626
1627 Returns
1628 -------
1629 calibMagErr: `~numpy.ndarray` or `~pandas.Series`
1630 Error on calibrated AB magnitudes.
1631 """
1632 err = self.instFluxErrToNanojanskyErr(instFlux, instFluxErr, localCalib, localCalibErr)
1633 return 2.5 / np.log(10) * err / self.instFluxToNanojansky(instFlux, instFluxErr)
1634
1635
◆ instFluxErrToNanojanskyErr()
| lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToNanojanskyErr | ( | self, | |
| instFlux, | |||
| instFluxErr, | |||
| localCalib, | |||
| localCalibErr ) |
Convert instrument flux to nanojanskys.
Parameters
----------
instFlux : `~numpy.ndarray` or `~pandas.Series`
Array of instrument flux measurements.
instFluxErr : `~numpy.ndarray` or `~pandas.Series`
Errors on associated ``instFlux`` values.
localCalib : `~numpy.ndarray` or `~pandas.Series`
Array of local photometric calibration estimates.
localCalibErr : `~numpy.ndarray` or `~pandas.Series`
Errors on associated ``localCalib`` values.
Returns
-------
calibFluxErr : `~numpy.ndarray` or `~pandas.Series`
Errors on calibrated flux measurements.
Definition at line 1575 of file functors.py.
1575 def instFluxErrToNanojanskyErr(self, instFlux, instFluxErr, localCalib, localCalibErr):
1576 """Convert instrument flux to nanojanskys.
1577
1578 Parameters
1579 ----------
1580 instFlux : `~numpy.ndarray` or `~pandas.Series`
1581 Array of instrument flux measurements.
1582 instFluxErr : `~numpy.ndarray` or `~pandas.Series`
1583 Errors on associated ``instFlux`` values.
1584 localCalib : `~numpy.ndarray` or `~pandas.Series`
1585 Array of local photometric calibration estimates.
1586 localCalibErr : `~numpy.ndarray` or `~pandas.Series`
1587 Errors on associated ``localCalib`` values.
1588
1589 Returns
1590 -------
1591 calibFluxErr : `~numpy.ndarray` or `~pandas.Series`
1592 Errors on calibrated flux measurements.
1593 """
1594 return np.hypot(instFluxErr * localCalib, instFlux * localCalibErr)
1595
◆ instFluxToMagnitude()
| lsst.pipe.tasks.functors.LocalPhotometry.instFluxToMagnitude | ( | self, | |
| instFlux, | |||
| localCalib ) |
Convert instrument flux to nanojanskys.
Parameters
----------
instFlux : `~numpy.ndarray` or `~pandas.Series`
Array of instrument flux measurements.
localCalib : `~numpy.ndarray` or `~pandas.Series`
Array of local photometric calibration estimates.
Returns
-------
calibMag : `~numpy.ndarray` or `~pandas.Series`
Array of calibrated AB magnitudes.
Definition at line 1596 of file functors.py.
1596 def instFluxToMagnitude(self, instFlux, localCalib):
1597 """Convert instrument flux to nanojanskys.
1598
1599 Parameters
1600 ----------
1601 instFlux : `~numpy.ndarray` or `~pandas.Series`
1602 Array of instrument flux measurements.
1603 localCalib : `~numpy.ndarray` or `~pandas.Series`
1604 Array of local photometric calibration estimates.
1605
1606 Returns
1607 -------
1608 calibMag : `~numpy.ndarray` or `~pandas.Series`
1609 Array of calibrated AB magnitudes.
1610 """
1611 return -2.5 * np.log10(self.instFluxToNanojansky(instFlux, localCalib)) + self.logNJanskyToAB
1612
◆ instFluxToNanojansky()
| lsst.pipe.tasks.functors.LocalPhotometry.instFluxToNanojansky | ( | self, | |
| instFlux, | |||
| localCalib ) |
Convert instrument flux to nanojanskys.
Parameters
----------
instFlux : `~numpy.ndarray` or `~pandas.Series`
Array of instrument flux measurements.
localCalib : `~numpy.ndarray` or `~pandas.Series`
Array of local photometric calibration estimates.
Returns
-------
calibFlux : `~numpy.ndarray` or `~pandas.Series`
Array of calibrated flux measurements.
Definition at line 1558 of file functors.py.
1558 def instFluxToNanojansky(self, instFlux, localCalib):
1559 """Convert instrument flux to nanojanskys.
1560
1561 Parameters
1562 ----------
1563 instFlux : `~numpy.ndarray` or `~pandas.Series`
1564 Array of instrument flux measurements.
1565 localCalib : `~numpy.ndarray` or `~pandas.Series`
1566 Array of local photometric calibration estimates.
1567
1568 Returns
1569 -------
1570 calibFlux : `~numpy.ndarray` or `~pandas.Series`
1571 Array of calibrated flux measurements.
1572 """
1573 return instFlux * localCalib
1574
Member Data Documentation
◆ instFluxCol
| lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol |
Definition at line 1552 of file functors.py.
◆ instFluxErrCol
| lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol |
Definition at line 1553 of file functors.py.
◆ logNJanskyToAB
|
static |
Definition at line 1544 of file functors.py.
◆ photoCalibCol
| lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol |
Definition at line 1554 of file functors.py.
◆ photoCalibErrCol
| lsst.pipe.tasks.functors.LocalPhotometry.photoCalibErrCol |
Definition at line 1555 of file functors.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gd96a1ce819+42fd0ee607/python/lsst/pipe/tasks/functors.py
