Photometry Filters

The PhotometryFilter class interfaces with the Spanish Virtual Observatory Filter Profile Service to retrieve and cache filter transmission curves.

class ForMoSA.filter.filter.PhotometryFilter(facility, instrument, filter_id, filter_path=None, log_level='info', logger=None, display_unit=WavelengthUnit.MICROMETER)

Bases: object

PhotometryFilter class Defining a filter. The faclity, instrument and filter_id has to be under the right format (see https://svo2.cab.inta-csic.es/theory/fps/ for more details).

Parameters:

• facility (str) – Name of the facility (‘Paranal’, ‘Keck’, ‘JWST’, …)

• instrument (str) – Name of the instrument (‘SPHERE’, ‘NIRC2’, ‘NIRCam’, …)

• filter_id (str) – ID of the filter (‘IRDIS_B_H’, ‘Lp’, F410M)

• filter_path (str | PathLike | None) – Path where to save the filter data

• log_level (str) – Level of the logger

• logger (Logger | None) – Logger

• display_unit (WavelengthUnit) – Unit of the wavelength to display

Notes

Authors: Allan Denis

property logger: Logger

Logger.

property facility: str

Facility for the filter (e.g. ‘Paranal’, ‘Keck’, ‘JWST’, …).

property instrument: str

Instrument used of the filter (e.g. ‘SPHERE’, ‘NIRC2’, ‘NIRCam’, …).

property filter_id: str

ID of the filter (e.g. ‘IRDIS_B_H’, ‘Lp’, ‘F410M’, …).

property filter_path: Path

property name: str

Full name of the filter (e.g. ‘Paranal/SPHERE.IRDIS_B_H’, ‘Keck/NIRC2.Lp’, ‘JWST/NIRCam.F410M’).

property data: Table

Table containing the data of the filter (wavelength, transmission).

property unit: PrefixUnit

Unit to use for the wavelength.

property native_unit: PrefixUnit

Native unit of the wavelength (Angstrom).

property metadata: Table

Table containing the metadata of the filter.

property wavelength: Quantity

Wavelength grid of the filter.

property transmission: ndarray

Transmission of the filter.

property fwhm: Quantity

FWHM.

property zero_point: float64

Zero point.

property Mag0: float64

Magnitude 0.

property zero_point_type: str

//www.ivoa.net/documents/Notes/SVOFPS/NOTE-SVOFPS-1.0.20121015.pdf).

Type:

Zero point type (‘Pogson’, ‘Asinh’, ‘Linear’, see https

property softening_parameter: str

//www.ivoa.net/documents/Notes/SVOFPS/NOTE-SVOFPS-1.0.20121015.pdf).

Type:

Softening parameter (see https

property folder: Path

Folder of the filter.

property file_path: Path

Path of the filter.

property mean_wavelength: float

Mean integrated wavelength ($lambda_{mean} = frac{int_{lambda} lambda T(lambda) dlambda}{T(lambda) dlambda}$).

property central_wavelength: float

Central wavelength between the 2 wavelengths used to compute the FWHM.

property wavelength_eff: float

Mean integrated wavelength with Vega spectrum ($lambda_{ref} = frac{int_{lambda} lambda T(lambda) Vega(lambda) dlambda}{T(lambda) Vega(lambda) dlambda}$).

property peak_wavelength: float

Wavelength corresponding to the maximum of transmission.

property pivot_wavelength: float

Wavelength computed as sqrt{frac{lambda T(lambda) dlambda}{T(lambda) dlambda / lambda}}.

property photon_wavelength: float

Photon distribution based effective wavelength ($lambda_{phot} = frac{int_{lambda} lambda^2 T(lambda) Vega(lambda) dlambda}{lambda T(lambda) Vega(lambda) dlambda}$).

property wavelength_min: float

Minimum wavelength with transmission > 1% of maximum transmission.

property wavelength_max: float

Maximum wavelength with transmission > 1% of maximum transmission.

property wavelength_range: tuple[float, float]

Wavelength range.

property effective_width: float

Equivalent to the width of a rectangle with height equal to maximum transmission and with the same area that the one covered by the filter transmission curve ($Width_{eff} = frac{T(lambda) dlambda}{Max(T(lambda))}$).

property width: ndarray[float, float]

Width of the filter.