CalcEDiff¶

class lsst.analysis.tools.actions.vector.CalcEDiff(*args, **kw)¶

Bases: VectorAction

Calculate the difference of two ellipticities as a complex quantity.

The complex ellipticity difference between e_A and e_B is defined as \(e_{A} - e_{B} = de = |de|\exp{(j*2*theta)}\).

See also

CalcE

Notes

1. This is a shape measurement used for doing QA on the ellipticity of the sources.

For plotting purposes we might want to plot

\[|de|*\exp{(j*theta)}.\]

If halvePhaseAngle config parameter is set to True, then the returned quantity therefore corresponds to \(|e|*\exp{(j*theta)}\).

Attributes Summary

`colA`	Ellipticity to subtract from (`VectorAction`, default `<class 'lsst.analysis.tools.actions.vector.ellipticity.CalcE'>`)
`colB`	Ellipticity to subtract (`VectorAction`, default `<class 'lsst.analysis.tools.actions.vector.ellipticity.CalcE'>`)
`component`	Which component of the ellipticity to return.
`halvePhaseAngle`	Divide the phase angle by 2? Suitable for quiver plots.

Methods Summary

`__call__`(data, **kwargs)	Call self as a function.
`getInputSchema`()	Return the schema an `AnalysisAction` expects to be present in the arguments supplied to the __call__ method.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

colA¶: Ellipticity to subtract from (VectorAction, default <class 'lsst.analysis.tools.actions.vector.ellipticity.CalcE'>)

colB¶: Ellipticity to subtract (VectorAction, default <class 'lsst.analysis.tools.actions.vector.ellipticity.CalcE'>)

component¶

Which component of the ellipticity to return. If None, return complex ellipticity values. (str, default None)

Allowed values:

'1': e1 or g1 (depending on the ellipiticyType)
'2': e2 or g2 (depending on the ellipiticyType)
'None': Field is optional

halvePhaseAngle¶: Divide the phase angle by 2? Suitable for quiver plots. (bool, default False)

Methods Documentation

__call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap], **kwargs) → ndarray[Any, dtype[ScalarType]]¶: Call self as a function.

getInputSchema() → HealSparseMap]]]¶

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Returns:

resultKeyedDataSchema: The schema this action requires to be present when calling this action, keys are unformatted.

validate()¶

Validate the Config, raising an exception if invalid.

Raises:

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.

Navigation

CalcEDiff¶