HsmTraceSize

class lsst.pipe.tasks.functors.HsmTraceSize(filt=None, dataset=None, noDup=None)

Bases: Functor

Functor to calculate the HSM trace radius size for sources.

The HSM trace radius size is a measure of size equal to the square root of half of the trace of the second moments tensor measured with the HsmShapeAlgorithm plugin. This has units of pixels.

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

Columns required to perform calculation.

name = 'HSM Trace Size'

noDup

Do not explode by band if used on object table.

shortname = 'hsmTrace'

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.