SingleFrameCompensatedTophatFluxConfig

class lsst.meas.base.SingleFrameCompensatedTophatFluxConfig(*args, **kw)

Bases: SingleFramePluginConfig

Attributes Summary

apertures	The aperture radii (in pixels) to measure the top-hats.
doMeasure	whether to run this plugin in single-object mode (bool, default True)
inner_scale	Inner background annulus scale (relative to aperture).
outer_scale	Outer background annulus scale (relative to aperture).

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

apertures

The aperture radii (in pixels) to measure the top-hats. (List, default [12])

doMeasure

whether to run this plugin in single-object mode (bool, default True)

inner_scale

Inner background annulus scale (relative to aperture). (float, default 1.0)

Valid Range = [1.0,inf)

outer_scale

Outer background annulus scale (relative to aperture). (float, default 1.7)

Valid Range = [1.0,inf)

Methods Documentation

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.