LSST Applications g07dc498a13+cb17356775,g1409bbee79+cb17356775,g1a7e361dbc+cb17356775,g1fd858c14a+d1a2a640a9,g33399d78f5+fe6948661d,g35bb328faa+e55fef2c71,g3bd4b5ce2c+cac9e18807,g3c79e8cd92+2359a18b76,g43bc871e57+a58ba40925,g53246c7159+e55fef2c71,g60b5630c4e+8133a3545f,g78460c75b0+8427c4cc8f,g78619a8342+55305cb8f0,g786e29fd12+307f82e6af,g8534526c7b+8e1c6b434f,g89139ef638+cb17356775,g8b49a6ea8e+8133a3545f,g8ffcb69f3d+818ab6c36e,g9125e01d80+e55fef2c71,g97b8272a79+98425f45f6,g989de1cb63+cb17356775,g9f33ca652e+4245ceb508,gaaedd4e678+cb17356775,gabe3b4be73+9c0c3c7524,gb1101e3267+3e5ef1d639,gb58c049af0+28045f66fd,gc1fe0db326+8133a3545f,gca43fec769+e55fef2c71,gcf25f946ba+fe6948661d,gd397e13551+64039f84ea,gd6cbbdb0b4+f6e5445f66,gde0f65d7ad+7eb368c542,ge278dab8ac+b4c2c8faf7,geab183fbe5+8133a3545f,gecb8035dfe+1f480bec5e,gefa07fa684+e7bc33f3ea,gf58bf46354+e55fef2c71,gfe7187db8c+e55afb4430,w.2025.03
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.LocalPhotometry Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.LocalPhotometry:
lsst.pipe.tasks.functors.Functor lsst.pipe.tasks.functors.LocalDipoleMeanFlux lsst.pipe.tasks.functors.LocalNanojansky lsst.pipe.tasks.functors.LocalNanojanskyErr lsst.pipe.tasks.functors.LocalDipoleDiffFlux lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr

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 1639 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 1661 of file functors.py.

1666 **kwargs):
1667 self.instFluxCol = instFluxCol
1668 self.instFluxErrCol = instFluxErrCol
1669 self.photoCalibCol = photoCalibCol
1670 self.photoCalibErrCol = photoCalibErrCol
1671 super().__init__(**kwargs)
1672

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 1728 of file functors.py.

1728 def instFluxErrToMagnitudeErr(self, instFlux, instFluxErr, localCalib, localCalibErr):
1729 """Convert instrument flux err to nanojanskys.
1730
1731 Parameters
1732 ----------
1733 instFlux : `~numpy.ndarray` or `~pandas.Series`
1734 Array of instrument flux measurements.
1735 instFluxErr : `~numpy.ndarray` or `~pandas.Series`
1736 Errors on associated ``instFlux`` values.
1737 localCalib : `~numpy.ndarray` or `~pandas.Series`
1738 Array of local photometric calibration estimates.
1739 localCalibErr : `~numpy.ndarray` or `~pandas.Series`
1740 Errors on associated ``localCalib`` values.
1741
1742 Returns
1743 -------
1744 calibMagErr: `~numpy.ndarray` or `~pandas.Series`
1745 Error on calibrated AB magnitudes.
1746 """
1747 err = self.instFluxErrToNanojanskyErr(instFlux, instFluxErr, localCalib, localCalibErr)
1748 return 2.5 / np.log(10) * err / self.instFluxToNanojansky(instFlux, instFluxErr)
1749
1750

◆ 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 1690 of file functors.py.

1690 def instFluxErrToNanojanskyErr(self, instFlux, instFluxErr, localCalib, localCalibErr):
1691 """Convert instrument flux to nanojanskys.
1692
1693 Parameters
1694 ----------
1695 instFlux : `~numpy.ndarray` or `~pandas.Series`
1696 Array of instrument flux measurements.
1697 instFluxErr : `~numpy.ndarray` or `~pandas.Series`
1698 Errors on associated ``instFlux`` values.
1699 localCalib : `~numpy.ndarray` or `~pandas.Series`
1700 Array of local photometric calibration estimates.
1701 localCalibErr : `~numpy.ndarray` or `~pandas.Series`
1702 Errors on associated ``localCalib`` values.
1703
1704 Returns
1705 -------
1706 calibFluxErr : `~numpy.ndarray` or `~pandas.Series`
1707 Errors on calibrated flux measurements.
1708 """
1709 return np.hypot(instFluxErr * localCalib, instFlux * localCalibErr)
1710

◆ 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 1711 of file functors.py.

1711 def instFluxToMagnitude(self, instFlux, localCalib):
1712 """Convert instrument flux to nanojanskys.
1713
1714 Parameters
1715 ----------
1716 instFlux : `~numpy.ndarray` or `~pandas.Series`
1717 Array of instrument flux measurements.
1718 localCalib : `~numpy.ndarray` or `~pandas.Series`
1719 Array of local photometric calibration estimates.
1720
1721 Returns
1722 -------
1723 calibMag : `~numpy.ndarray` or `~pandas.Series`
1724 Array of calibrated AB magnitudes.
1725 """
1726 return -2.5 * np.log10(self.instFluxToNanojansky(instFlux, localCalib)) + self.logNJanskyToAB
1727

◆ 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 1673 of file functors.py.

1673 def instFluxToNanojansky(self, instFlux, localCalib):
1674 """Convert instrument flux to nanojanskys.
1675
1676 Parameters
1677 ----------
1678 instFlux : `~numpy.ndarray` or `~pandas.Series`
1679 Array of instrument flux measurements.
1680 localCalib : `~numpy.ndarray` or `~pandas.Series`
1681 Array of local photometric calibration estimates.
1682
1683 Returns
1684 -------
1685 calibFlux : `~numpy.ndarray` or `~pandas.Series`
1686 Array of calibrated flux measurements.
1687 """
1688 return instFlux * localCalib
1689

Member Data Documentation

◆ instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol

Definition at line 1667 of file functors.py.

◆ instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol

Definition at line 1668 of file functors.py.

◆ logNJanskyToAB

tuple lsst.pipe.tasks.functors.LocalPhotometry.logNJanskyToAB = (1 * u.nJy).to_value(u.ABmag)
static

Definition at line 1659 of file functors.py.

◆ photoCalibCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol

Definition at line 1669 of file functors.py.

◆ photoCalibErrCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibErrCol

Definition at line 1670 of file functors.py.

The documentation for this class was generated from the following file:
Generated on Fri Jan 17 2025 09:31:29 for LSST Applications by doxygen 1.11.0