PhotometryApertures#

class stellarphot.settings.PhotometryApertures(*arg, variable_aperture: bool = False, radius: Annotated[float, Gt(gt=0)] = 1, gap: Annotated[float, Gt(gt=0)] = 1, annulus_width: Annotated[float, Gt(gt=0)] = 1, fwhm_estimate: Annotated[float, Gt(gt=0)] = 1.0)[source]#

Bases: BaseModelWithTableRep

Settings for aperture photometry.

Parameters:

radiusint: Radius of the aperture in pixels, must be greater than or equal to 1.
gapint: Distance between the radius and the inner annulus in pixels, must be greater than or equal to 1.
annulus_widthint: Width of the annulus in pixels, must be greater than or equal to 1.
fwhmfloat: Full width at half maximum of the typical star in pixels.

Attributes:

inner_annulusint: Radius of the inner annulus in pixels.
outer_annulusint: Radius of the outer annulus in pixels.

Examples

To create an PhotometryApertures object, you can pass in the radius, gap, and annulus_width as keyword arguments:

>>> aperture_settings = PhotometryApertures(
...     radius=4,
...     gap=10,
...     annulus_width=15,
...     fwhm=3.0
... )

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes Summary

`inner_annulus`	Radius of the inner annulus in pixels.
`model_config`	Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
`outer_annulus`	Radius of the outer annulus in pixels.

Methods Summary

radius_pixels(fwhm)

Return the radius in pixels, depending on whether the aperture is variable or not.

Attributes Documentation

inner_annulus#: Radius of the inner annulus in pixels.

model_config = {'extra': 'forbid', 'json_schema_extra': {'description': 'Settings for aperture photometry.'}, 'validate_assignment': True, 'validate_default': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

outer_annulus#: Radius of the outer annulus in pixels.

Methods Documentation

radius_pixels(fwhm)[source]#: Return the radius in pixels, depending on whether the aperture is variable or not.