lsst.pipe.tasks g731793462a+50b2f1fa7d
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
lsst.pipe.tasks.functors.SemimajorAxisFromCorrelation Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.SemimajorAxisFromCorrelation:
lsst.pipe.tasks.functors.SemimajorAxisFromMoments lsst.pipe.tasks.functors.MomentsBase lsst.pipe.tasks.functors.Functor

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

SemimajorAxisFromMoments but from sigma_x, sigma_y, rho correlation terms.

Definition at line 2307 of file functors.py.

Member Function Documentation

◆ __call__()

lsst.pipe.tasks.functors.Functor.__call__ ( self,
data,
dropna = False )
inherited

Definition at line 355 of file functors.py.

◆ _colsFromDict()

lsst.pipe.tasks.functors.Functor._colsFromDict ( self,
colDict,
columnIndex = None )
protectedinherited 
Converts dictionary column specficiation to a list of columns.

Definition at line 225 of file functors.py.

◆ _dropna()

lsst.pipe.tasks.functors.Functor._dropna ( self,
vals )
protectedinherited

Definition at line 352 of file functors.py.

◆ _func()

lsst.pipe.tasks.functors.SemimajorAxisFromMoments._func ( self,
df )
protectedinherited

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 2299 of file functors.py.

◆ _get_columnIndex()

lsst.pipe.tasks.functors.Functor._get_columnIndex ( self,
data )
protectedinherited 
Return columnIndex.

Definition at line 301 of file functors.py.

◆ _get_data()

lsst.pipe.tasks.functors.Functor._get_data ( self,
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 309 of file functors.py.

◆ _get_data_columnLevelNames()

lsst.pipe.tasks.functors.Functor._get_data_columnLevelNames ( self,
data,
columnIndex = None )
protectedinherited 
Gets the content of each of the column levels for a multilevel
table.

Definition at line 211 of file functors.py.

◆ _get_data_columnLevels()

lsst.pipe.tasks.functors.Functor._get_data_columnLevels ( self,
data,
columnIndex = None )
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 191 of file functors.py.

◆ _setLevels()

lsst.pipe.tasks.functors.Functor._setLevels ( self,
df )
protectedinherited

Definition at line 347 of file functors.py.

◆ columns()

lsst.pipe.tasks.functors.MomentsBase.columns ( self)
inherited 
Columns required to perform calculation.

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 2057 of file functors.py.

◆ columns_ref()

lsst.pipe.tasks.functors.MomentsBase.columns_ref ( self)
inherited 
Return columns that are needed from the ref table.

Definition at line 2065 of file functors.py.

◆ compute_ellipse_terms()

lsst.pipe.tasks.functors.MomentsBase.compute_ellipse_terms ( self,
df,
bool sky = True )
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 2073 of file functors.py.

◆ difference()

lsst.pipe.tasks.functors.Functor.difference ( self,
data1,
data2,
** kwargs )
inherited 
Computes difference between functor called on two different
DataFrame/Handle objects.

Definition at line 367 of file functors.py.

◆ fail()

lsst.pipe.tasks.functors.Functor.fail ( self,
df )
inherited

Definition at line 373 of file functors.py.

◆ get_g1()

lsst.pipe.tasks.functors.MomentsBase.get_g1 ( self,
df )
inherited 
Calculate shear-type ellipticity parameter G1.

Definition at line 2149 of file functors.py.

◆ get_g2()

lsst.pipe.tasks.functors.MomentsBase.get_g2 ( self,
df )
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 2160 of file functors.py.

◆ get_trace()

lsst.pipe.tasks.functors.MomentsBase.get_trace ( self,
df )
inherited

Definition at line 2174 of file functors.py.

◆ get_xx()

lsst.pipe.tasks.functors.MomentsBase.get_xx ( self,
df )
inherited

Definition at line 2103 of file functors.py.

◆ get_xy()

lsst.pipe.tasks.functors.MomentsBase.get_xy ( self,
df )
inherited

Definition at line 2111 of file functors.py.

◆ get_yy()

lsst.pipe.tasks.functors.MomentsBase.get_yy ( self,
df )
inherited

Definition at line 2107 of file functors.py.

◆ multilevelColumns()

lsst.pipe.tasks.functors.Functor.multilevelColumns ( self,
data,
columnIndex = None,
returnTuple = False )
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 244 of file functors.py.

◆ name()

lsst.pipe.tasks.functors.Functor.name ( self)
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 377 of file functors.py.

◆ noDup()

lsst.pipe.tasks.functors.Functor.noDup ( self)
inherited 
Do not explode by band if used on object table.

Definition at line 177 of file functors.py.

◆ shortname()

lsst.pipe.tasks.functors.Functor.shortname ( self)
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 382 of file functors.py.

◆ sky_uu()

lsst.pipe.tasks.functors.MomentsBase.sky_uu ( self,
df )
inherited 
Return the component of the moments tensor aligned with the RA axis, in radians.

Definition at line 2117 of file functors.py.

◆ sky_uv()

lsst.pipe.tasks.functors.MomentsBase.sky_uv ( self,
df )
inherited 
Return the covariance of the moments tensor in ra, dec coordinates, in radians.

Definition at line 2137 of file functors.py.

◆ sky_vv()

lsst.pipe.tasks.functors.MomentsBase.sky_vv ( self,
df )
inherited 
Return the component of the moments tensor aligned with the dec axis, in radians.

Definition at line 2127 of file functors.py.

Member Data Documentation

◆ _defaultDataset

str lsst.pipe.tasks.functors.Functor._defaultDataset = 'ref'
staticprotectedinherited

Definition at line 166 of file functors.py.

◆ _defaultNoDup

bool lsst.pipe.tasks.functors.Functor._defaultNoDup = False
staticprotectedinherited

Definition at line 168 of file functors.py.

◆ _dfLevels

tuple lsst.pipe.tasks.functors.Functor._dfLevels = ('column',)
staticprotectedinherited

Definition at line 167 of file functors.py.

◆ _noDup

lsst.pipe.tasks.functors.Functor._noDup = noDup
protectedinherited

Definition at line 173 of file functors.py.

◆ colCD_1_1

lsst.pipe.tasks.functors.MomentsBase.colCD_1_1 = colCD_1_1
inherited

Definition at line 2050 of file functors.py.

◆ colCD_1_2

lsst.pipe.tasks.functors.MomentsBase.colCD_1_2 = colCD_1_2
inherited

Definition at line 2051 of file functors.py.

◆ colCD_2_1

lsst.pipe.tasks.functors.MomentsBase.colCD_2_1 = colCD_2_1
inherited

Definition at line 2052 of file functors.py.

◆ colCD_2_2

lsst.pipe.tasks.functors.MomentsBase.colCD_2_2 = colCD_2_2
inherited

Definition at line 2053 of file functors.py.

◆ dataset

str lsst.pipe.tasks.functors.Functor.dataset = dataset if dataset is not None else self._defaultDataset
inherited

Definition at line 172 of file functors.py.

◆ filt

lsst.pipe.tasks.functors.Functor.filt = 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 171 of file functors.py.

◆ is_covariance

bool lsst.pipe.tasks.functors.MomentsBase.is_covariance = True
staticinherited

Definition at line 2036 of file functors.py.

◆ log

lsst.pipe.tasks.functors.Functor.log = logging.getLogger(type(self).__name__)
inherited

Definition at line 174 of file functors.py.

◆ name

lsst.pipe.tasks.functors.Functor.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 360 of file functors.py.

◆ shape_1_1

lsst.pipe.tasks.functors.MomentsBase.shape_1_1 = shape_1_1
inherited

Definition at line 2047 of file functors.py.

◆ shape_1_2

lsst.pipe.tasks.functors.MomentsBase.shape_1_2 = shape_1_2
inherited

Definition at line 2049 of file functors.py.

◆ shape_2_2

lsst.pipe.tasks.functors.MomentsBase.shape_2_2 = shape_2_2
inherited

Definition at line 2048 of file functors.py.

The documentation for this class was generated from the following file:
Generated on for lsst.pipe.tasks by doxygen 1.18.0