exosim.tasks.radiometric.estimateApertures#

Classes#

EstimateApertures

It returns the sizes of the apertures to perform photometry for photutils.aperture.aperture_photometry.

Module Contents#

class EstimateApertures[source]#

Bases: exosim.tasks.task.Task

It returns the sizes of the apertures to perform photometry for photutils.aperture.aperture_photometry. The details of the apertures depends on the configurations set by the user.

Return type:

astropy.table.QTable

Raises:

TypeError: – if the output is not QTable

Notes

This is a default class with standardised inputs and outputs. The user can load this class and overwrite the “model” method to implement a custom Task to replace this.

execute()[source]#

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

model(table, focal_plane, description, wl_grid)[source]#

It returns the sizes of the apertures to perform photometry for photutils.aperture.aperture_photometry. The default methods to estimate the aperture are the following and these are also the keywords required for the description dictionary.

  • spatial_mode: str

    aperture in spatial direction. If column the aperture spatial length is the full pixel column in the array. Default is column.

  • spectral_mode: str

    aperture in spectral direction. If row the aperture is spectral length is the full pixel row of the array. If wl_solution the spectral size is the same of the spectral bin in the input table. Default is ‘wl_solution`.

  • auto_mode: str

    automatic aperture mode. The dictionary must contains two keywords. The mode keyword should be a str: if rectangular then find_rectangular_aperture is used; if elliptical then find_elliptical_aperture is used; if bin then find_bin_aperture is used; if full then the full array is integrated.

  • Ene: float

    The EnE keyword should be a float and represents the Encircled Energy to include in the aperture.

Parameters:

  • table (astropy.table.QTable) – wavelength table with bin edge

  • focal_plane – focal plane

  • description (dict) – dictionary containing the aperture photometry description

Return type:

astropy.table.QTable