E1

class lsst.pipe.tasks.functors.E1(colXX, colXY, colYY, **kwargs)

Bases: Functor

Calculate \(e_1\) ellipticity component for sources, defined as:

\[e_1 &= (I_{xx}-I_{yy})/(I_{xx}+I_{yy})\]

See also

E2

Attributes Summary

columns

Columns required to perform calculation.

name

noDup

Do not explode by band if used on object table.

shortname

Methods Summary

__call__(data[, dropna])

Call self as a function.

difference(data1, data2, **kwargs)

Computes difference between functor called on two different DataFrame/Handle objects.

fail(df)

multilevelColumns(data[, columnIndex, ...])

Returns columns needed by functor from multilevel dataset.

Attributes Documentation

columns
name = 'Distortion Ellipticity (e1)'
noDup

Do not explode by band if used on object table.

shortname = 'Distortion'

Methods Documentation

__call__(data, dropna=False)

Call self as a function.

difference(data1, data2, **kwargs)

Computes difference between functor called on two different DataFrame/Handle objects.

fail(df)
multilevelColumns(data, columnIndex=None, returnTuple=False)

Returns columns needed by functor from multilevel dataset.

To access tables with multilevel column structure, the DeferredDatasetHandle or InMemoryDatasetHandle needs to be passed either a list of tuples or a dictionary.

Parameters:
datavarious

The data as either DeferredDatasetHandle, or InMemoryDatasetHandle.

columnIndex (optional): pandas `~pandas.Index` object

Either passed or read in from 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.