EffectiveAreaFundamental#

class xrtpy.response.EffectiveAreaFundamental(filter_name, observation_date)[source]#

Bases: object

Class for calculating the effective area for an XRT filter at a specific observation date.

This class handles the calculations required to determine the effective area of a filter used in the X-Ray Telescope (XRT) on the Hinode satellite. It considers various factors such as contamination on the CCD and filters, as well as the geometry and transmission of the XRT channel.

Parameters:

filter_name (str) – The name of the filter.
observation_date (str or datetime.datetime) – The date of the observation. Acceptable formats include any string or datetime object that can be parsed by sunpy.time.parse_time.

Attributes Summary

`ccd_contam_data`
`channel_geometry_aperture_area`	XRT flight model geometry aperture area.
`channel_transmission`	XRT channel transmission.
`contamination_on_CCD`	Calculate the thickness of the contamination layer on the CCD.
`contamination_on_filter1`	Interpolates contamination layer thickness on filter1.
`contamination_on_filter2`	Interpolates the contamination thickness on filter2, if using a combo filter.
`filter1_name`	Name of the first filter given.
`filter2_name`	Name of the second filter given.
`filter_data_dates_to_seconds`	Returns the contamination file time axis in seconds (utime).
`filter_observation_date_to_seconds`	Returns the observation date in seconds (utime).
`is_combo`	True if the filter is a combination (e.g., 'Al-poly/Ti-poly'), False otherwise.
`n_DEHP_attributes`	(Diethylhexylphthalate) Wavelength (nm), Delta, Beta.
`n_DEHP_beta`	(Diethylhexylphthalate) Beta.
`n_DEHP_delta`	(Diethylhexylphthalate) Delta.
`n_DEHP_wavelength`	(Diethylhexylphthalate) Wavelength given in Angstrom (Å).
`name`	The resolved name of the filter or filter combination.
`observation_date`	Date of observation.
`wavelength`	Array of wavelengths for every X-ray channel in Angstroms (Å).

Methods Summary

effective_area()

Calculate the Effective Area.

Attributes Documentation

ccd_contam_data[source]#

channel_geometry_aperture_area#: XRT flight model geometry aperture area.

channel_transmission#: XRT channel transmission.

contamination_on_CCD#

Calculate the thickness of the contamination layer on the CCD.

This property interpolates the contamination data over time to determine the thickness of the contamination layer on the CCD at the observation date. The contamination layer is measured in Angstroms (Å).

Returns:: astropy.units.Quantity – The thickness of the contamination layer on the CCD, in Angstroms.

Notes

The interpolation is performed using a linear interpolation method over the available contamination data points. The observation_date attribute is used to provide the point at which to evaluate the interpolation.

Raises:: ValueError – If the observation date is outside the range of the available contamination data.

contamination_on_filter1#: Interpolates contamination layer thickness on filter1.

contamination_on_filter2#

Interpolates the contamination thickness on filter2, if using a combo filter.

Returns:: astropy.units.Quantity or None – Contamination thickness in Angstroms for filter2 if present; otherwise None.

filter1_name#: Name of the first filter given.

filter2_name#: Name of the second filter given.

filter_data_dates_to_seconds#: Returns the contamination file time axis in seconds (utime).

filter_observation_date_to_seconds#: Returns the observation date in seconds (utime).

is_combo#: True if the filter is a combination (e.g., ‘Al-poly/Ti-poly’), False otherwise.

n_DEHP_attributes[source]#: (Diethylhexylphthalate) Wavelength (nm), Delta, Beta.

n_DEHP_beta[source]#: (Diethylhexylphthalate) Beta.

n_DEHP_delta[source]#: (Diethylhexylphthalate) Delta.

n_DEHP_wavelength[source]#: (Diethylhexylphthalate) Wavelength given in Angstrom (Å).

name#: The resolved name of the filter or filter combination.

observation_date#: Date of observation.

wavelength#: Array of wavelengths for every X-ray channel in Angstroms (Å).

Methods Documentation

effective_area()[source]#

Calculate the Effective Area.

The effective area is calculated by considering the geometry of the XRT flight model, the channel transmission, and the contamination layers on both the CCD and the filter.

Returns:: astropy.units.Quantity – Effective area in cm\(^2\).

Notes

The effective area is a crucial parameter for determining the sensitivity of the XRT to X-ray emissions. This method combines various factors, including the physical properties of the filter and CCD, to compute the total effective area.