Public Member Functions | |
| columns (self) | |
| columns_ref (self) | |
| compute_ellipse_terms (self, df, bool sky=True) | |
| get_xx (self, df) | |
| get_yy (self, df) | |
| get_xy (self, df) | |
| sky_uu (self, df) | |
| sky_vv (self, df) | |
| sky_uv (self, df) | |
| get_g1 (self, df) | |
| get_g2 (self, df) | |
| get_trace (self, df) | |
| name (self) | |
| noDup (self) | |
| multilevelColumns (self, data, columnIndex=None, returnTuple=False) | |
| __call__ (self, data, dropna=False) | |
| difference (self, data1, data2, **kwargs) | |
| fail (self, df) | |
| shortname (self) | |
Public Attributes | |
| shape_1_1 = shape_1_1 | |
| shape_2_2 = shape_2_2 | |
| shape_1_2 = shape_1_2 | |
| colCD_1_1 = colCD_1_1 | |
| colCD_1_2 = colCD_1_2 | |
| colCD_2_1 = colCD_2_1 | |
| colCD_2_2 = colCD_2_2 | |
| filt = filt | |
| str | dataset = dataset if dataset is not None else self._defaultDataset |
| log = logging.getLogger(type(self).__name__) | |
| name | |
Static Public Attributes | |
| bool | is_covariance = True |
Protected Member Functions | |
| _func (self, df) | |
| _get_data_columnLevels (self, data, columnIndex=None) | |
| _get_data_columnLevelNames (self, data, columnIndex=None) | |
| _colsFromDict (self, colDict, columnIndex=None) | |
| _get_columnIndex (self, data) | |
| _get_data (self, data) | |
| _setLevels (self, df) | |
| _dropna (self, vals) | |
Protected Attributes | |
| _noDup = noDup | |
Static Protected Attributes | |
| str | _defaultDataset = 'ref' |
| tuple | _dfLevels = ('column',) |
| bool | _defaultNoDup = False |
Detailed Description
MomentsIvvSky but from sigma_x, sigma_y, rho correlation terms.
Definition at line 2219 of file functors.py.
Member Function Documentation
◆ __call__()
|
inherited |
Definition at line 353 of file functors.py.
◆ _colsFromDict()
|
protectedinherited |
Converts dictionary column specficiation to a list of columns.
Definition at line 223 of file functors.py.
◆ _dropna()
|
protectedinherited |
Definition at line 350 of file functors.py.
◆ _func()
|
protectedinherited |
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 2213 of file functors.py.
◆ _get_columnIndex()
|
protectedinherited |
Return columnIndex.
Definition at line 299 of file functors.py.
◆ _get_data()
|
protectedinherited |
Retrieve DataFrame necessary for calculation. The data argument can be a `~pandas.DataFrame`, a `~lsst.daf.butler.DeferredDatasetHandle`, or an `~lsst.pipe.base.InMemoryDatasetHandle`. Returns a DataFrame upon which `self._func` can act.
Definition at line 307 of file functors.py.
◆ _get_data_columnLevelNames()
|
protectedinherited |
Gets the content of each of the column levels for a multilevel table.
Definition at line 209 of file functors.py.
◆ _get_data_columnLevels()
|
protectedinherited |
Gets the names of the column index levels.
This should only be called in the context of a multilevel table.
Parameters
----------
data : various
The data to be read, can be a
`~lsst.daf.butler.DeferredDatasetHandle` or
`~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
If not passed, then it is read from the
`~lsst.daf.butler.DeferredDatasetHandle`
for `~lsst.pipe.base.InMemoryDatasetHandle`.
Definition at line 189 of file functors.py.
◆ _setLevels()
|
protectedinherited |
Definition at line 345 of file functors.py.
◆ columns()
|
inherited |
Columns required to perform calculation.
Reimplemented from lsst.pipe.tasks.functors.Functor.
Definition at line 2025 of file functors.py.
◆ columns_ref()
|
inherited |
Return columns that are needed from the ref table.
Definition at line 2033 of file functors.py.
◆ compute_ellipse_terms()
|
inherited |
Return terms commonly used for ellipse parameterization conversions.
Parameters
----------
df
The data frame.
sky
Whether to compute the terms in sky coordinates.
If False, XX, YY and XY moments are used instead of
UU, VV and UV.
Returns
-------
xx_p_yy
The sum of the diagonal terms of the covariance.
xx_m_yy
The difference of the diagonal terms of the covariance.
t2
A term similar to the discriminant of the quadratic formula.
Definition at line 2041 of file functors.py.
◆ difference()
|
inherited |
Computes difference between functor called on two different DataFrame/Handle objects.
Definition at line 365 of file functors.py.
◆ fail()
|
inherited |
Definition at line 371 of file functors.py.
◆ get_g1()
|
inherited |
Calculate shear-type ellipticity parameter G1.
Definition at line 2117 of file functors.py.
◆ get_g2()
|
inherited |
Calculate shear-type ellipticity parameter G2. This has the opposite sign as sky_uv in order to maintain consistency with the HSM moments sign convention.
Definition at line 2128 of file functors.py.
◆ get_trace()
|
inherited |
Definition at line 2142 of file functors.py.
◆ get_xx()
|
inherited |
Definition at line 2071 of file functors.py.
◆ get_xy()
|
inherited |
Definition at line 2079 of file functors.py.
◆ get_yy()
|
inherited |
Definition at line 2075 of file functors.py.
◆ multilevelColumns()
|
inherited |
Returns columns needed by functor from multilevel dataset.
To access tables with multilevel column structure, the
`~lsst.daf.butler.DeferredDatasetHandle` or
`~lsst.pipe.base.InMemoryDatasetHandle` needs to be passed
either a list of tuples or a dictionary.
Parameters
----------
data : various
The data as either `~lsst.daf.butler.DeferredDatasetHandle`, or
`~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
Either passed or read in from
`~lsst.daf.butler.DeferredDatasetHandle`.
`returnTuple` : `bool`
If true, then return a list of tuples rather than the column
dictionary specification.
This is set to `True` by `CompositeFunctor` in order to be able to
combine columns from the various component functors.
Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.CompositeFunctor.
Definition at line 242 of file functors.py.
◆ name()
|
inherited |
Full name of functor (suitable for figure labels).
Reimplemented in lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.MagErr, and lsst.pipe.tasks.functors.Photometry.
Definition at line 375 of file functors.py.
◆ noDup()
|
inherited |
Do not explode by band if used on object table.
Definition at line 175 of file functors.py.
◆ shortname()
|
inherited |
Short name of functor (suitable for column name/dict key).
Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.MagDiff.
Definition at line 380 of file functors.py.
◆ sky_uu()
|
inherited |
Return the component of the moments tensor aligned with the RA axis, in radians.
Definition at line 2085 of file functors.py.
◆ sky_uv()
|
inherited |
Return the covariance of the moments tensor in ra, dec coordinates, in radians.
Definition at line 2105 of file functors.py.
◆ sky_vv()
|
inherited |
Return the component of the moments tensor aligned with the dec axis, in radians.
Definition at line 2095 of file functors.py.
Member Data Documentation
◆ _defaultDataset
|
staticprotectedinherited |
Definition at line 164 of file functors.py.
◆ _defaultNoDup
|
staticprotectedinherited |
Definition at line 166 of file functors.py.
◆ _dfLevels
|
staticprotectedinherited |
Definition at line 165 of file functors.py.
◆ _noDup
|
protectedinherited |
Definition at line 171 of file functors.py.
◆ colCD_1_1
|
inherited |
Definition at line 2018 of file functors.py.
◆ colCD_1_2
|
inherited |
Definition at line 2019 of file functors.py.
◆ colCD_2_1
|
inherited |
Definition at line 2020 of file functors.py.
◆ colCD_2_2
|
inherited |
Definition at line 2021 of file functors.py.
◆ dataset
|
inherited |
Definition at line 170 of file functors.py.
◆ filt
|
inherited |
Reimplemented in lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.CompositeFunctor, and lsst.pipe.tasks.functors.CompositeFunctor.
Definition at line 169 of file functors.py.
◆ is_covariance
|
staticinherited |
Definition at line 2004 of file functors.py.
◆ log
|
inherited |
Definition at line 172 of file functors.py.
◆ name
|
inherited |
Reimplemented in lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.CustomFunctor, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.MagErr, and lsst.pipe.tasks.functors.Photometry.
Definition at line 358 of file functors.py.
◆ shape_1_1
|
inherited |
Definition at line 2015 of file functors.py.
◆ shape_1_2
|
inherited |
Definition at line 2017 of file functors.py.
◆ shape_2_2
|
inherited |
Definition at line 2016 of file functors.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/functors.py
Generated on Wed Apr 22 2026 08:53:32 for lsst.pipe.tasks by
1.13.2