lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig Class Reference

Inheritance diagram for lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig:

Public Member Functions
	validate (self)

Static Public Attributes
	apertures
	inner_scale
	outer_scale

Detailed Description

Definition at line 42 of file _compensatedTophat.py.

Member Function Documentation

validate()

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.validate

(

self

)

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 `~lsst.pex.config.Field.validate` methods.

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

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

Reimplemented from lsst.pex.config.config.Config.

Definition at line 62 of file _compensatedTophat.py.

    def validate(self):
        super().validate()
 
        if not (self.outer_scale > self.inner_scale):
            raise ValueError("The outer_scale must be greater than the inner_scale")
 
 
@register("base_CompensatedTophatFlux")

Member Data Documentation

apertures

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.apertures

static

Initial value:

=  ListField(
        doc="The aperture radii (in pixels) to measure the top-hats.",
        dtype=int,
        minLength=1,
        default=[12,],
    )

Definition at line 43 of file _compensatedTophat.py.

inner_scale

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.inner_scale

static

Initial value:

=  RangeField(
        doc="Inner background annulus scale (relative to aperture).",
        dtype=float,
        default=1.0,
        min=1.0,
    )

Definition at line 49 of file _compensatedTophat.py.

outer_scale

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.outer_scale

static

Initial value:

=  RangeField(
        doc="Outer background annulus scale (relative to aperture).",
        dtype=float,
        default=1.7,
        min=1.0,
    )

Definition at line 55 of file _compensatedTophat.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_base/g5a97de2502+520531a62c/python/lsst/meas/base/compensatedGaussian/_compensatedTophat.py