esbo_etc.classes.psf package

Submodules

esbo_etc.classes.psf.AGriddedPSF module

class esbo_etc.classes.psf.AGriddedPSF.AGriddedPSF(**func_kwargs)[source]

Bases: esbo_etc.classes.psf.IPSF.IPSF

A class for modelling the PSF from a two dimensional grid

calcReducedObservationAngle(contained_energy: Union[str, int, float, astropy.units.quantity.Quantity], jitter_sigma: astropy.units.quantity.Quantity = None, obstruction: float = 0.0) → astropy.units.quantity.Quantity[source]

Calculate the reduced observation angle in lambda / d_ap for the given contained energy.

Parameters

  • contained_energy (Union[str, int, float, u.Quantity]) – The percentage of energy to be contained within a circle with the diameter reduced observation angle.

  • jitter_sigma (Quantity) – Sigma of the telescope’s jitter in arcsec

  • obstruction (float) – The central obstruction as ratio A_ob / A_ap

Returns

reduced_observation_angle (Quantity) – The reduced observation angle in lambda / d_ap

mapToPixelMask(mask: esbo_etc.classes.sensor.PixelMask.PixelMask, jitter_sigma: astropy.units.quantity.Quantity = None, obstruction: float = 0.0) → esbo_etc.classes.sensor.PixelMask.PixelMask[source]

Map the integrated PSF values to a sensor grid.

Parameters

  • obstruction –

  • mask (PixelMask) – The pixel mask to map the values to. The values will only be mapped onto entries with the value 1.

  • jitter_sigma (Quantity) – Sigma of the telescope’s jitter in arcsec

Returns

mask (PixelMask) – The pixel mask with the integrated PSF values mapped onto each pixel.

esbo_etc.classes.psf.Airy module

class esbo_etc.classes.psf.Airy.Airy(**func_kwargs)[source]

Bases: esbo_etc.classes.psf.IPSF.IPSF

A class for modelling the PSF using an airy disk.

calcReducedObservationAngle(contained_energy: Union[str, int, float], jitter_sigma: astropy.units.quantity.Quantity = None, obstruction: float = 0.0) → astropy.units.quantity.Quantity[source]

Calculate the reduced observation angle in lambda / d_ap for the given contained energy.

Parameters

  • contained_energy (Union[str, int, float]) – The percentage of energy to be contained within a circle with the diameter reduced observation angle.

  • jitter_sigma (Quantity) – Sigma of the telescope’s jitter in arcsec

  • obstruction (float) – The central obstruction as ratio A_ob / A_ap

Returns

reduced_observation_angle (Quantity) – The reduced observation angle in lambda / d_ap

mapToPixelMask(mask: esbo_etc.classes.sensor.PixelMask.PixelMask, jitter_sigma: astropy.units.quantity.Quantity = None, obstruction: float = 0.0) → esbo_etc.classes.sensor.PixelMask.PixelMask[source]

Map the integrated PSF values to a sensor grid.

Parameters

  • obstruction (float) –

  • mask (PixelMask) – The pixel mask to map the values to. The values will only be mapped onto entries with the value 1.

  • jitter_sigma (Quantity) – Sigma of the telescope’s jitter in arcsec

  • obstruction – The central obstruction as ratio A_ob / A_ap

Returns

mask (PixelMask) – The pixel mask with the integrated PSF values mapped onto each pixel.

esbo_etc.classes.psf.FITS module

class esbo_etc.classes.psf.FITS.FITS(**func_kwargs)[source]

Bases: esbo_etc.classes.psf.AGriddedPSF.AGriddedPSF

A class for modelling the PSF from a FITS-file

esbo_etc.classes.psf.IPSF module

class esbo_etc.classes.psf.IPSF.IPSF[source]

Bases: abc.ABC

Interface for modelling a PSF

abstract calcReducedObservationAngle(contained_energy: Union[str, int, float, astropy.units.quantity.Quantity], jitter_sigma: astropy.units.quantity.Quantity = None, obstruction: float = 0.0) → astropy.units.quantity.Quantity[source]

Calculate the reduced observation angle in lambda / d_ap for the given contained energy.

Parameters

  • contained_energy (Union[str, int, float, u.Quantity]) – The percentage of energy to be contained within a circle with the diameter reduced observation angle.

  • jitter_sigma (Quantity) – Sigma of the telescope’s jitter in arcsec

  • obstruction (float) – The central obstruction as ratio A_ob / A_ap

Returns

reduced_observation_angle (Quantity) – The reduced observation angle in lambda / d_ap

abstract mapToPixelMask(mask: esbo_etc.classes.sensor.PixelMask.PixelMask, jitter_sigma: astropy.units.quantity.Quantity = None, obstruction: float = 0.0) → esbo_etc.classes.sensor.PixelMask.PixelMask[source]

Map the integrated PSF values to a sensor grid.

Parameters

  • obstruction (float) –

  • mask (PixelMask) – The pixel mask to map the values to. The values will only be mapped onto entries with the value 1.

  • jitter_sigma (Quantity) – Sigma of the telescope’s jitter in arcsec

  • obstruction – The central obstruction as ratio A_ob / A_ap

Returns

mask (PixelMask) – The pixel mask with the integrated PSF values mapped onto each pixel.

esbo_etc.classes.psf.Zemax module

class esbo_etc.classes.psf.Zemax.Zemax(**func_kwargs)[source]

Bases: esbo_etc.classes.psf.AGriddedPSF.AGriddedPSF

A class for modelling the PSF from a Zemax output file

Module contents