antaress.ANTARESS_analysis.ANTARESS_inst_resp module#
- flag_err_inst(inst)[source]#
Spectrograph error flag
Returns boolean tracing whether error tables are provided with an instrumental dataset.
- Parameters:
inst (str) – ANTARESS name for the considered instrument configuration
- Returns:
err_flag (bool) – True if errors are provided
- return_spec_root(inst)[source]#
Spectrograph root name
Returns generic name of an instrument for a given configuration.
- Parameters:
inst (str) – ANTARESS name for the considered instrument configuration
- Returns:
spec_root (str) – generic instrument name
- return_spec_nord(inst)[source]#
Number of orders
Returns number of spectral orders in spectrographs.
- Parameters:
TBD
- Returns:
TBD
- return_SNR_orders(inst)[source]#
Orders for S/N ratio
Returns typical spectrograph order used for S/N measurements.
- Parameters:
TBD
- Returns:
TBD
- return_cen_wav_ord(inst)[source]#
Orders central wavelength
Returns central wavelength of each spectrograph order.
- Parameters:
inst (str) – ANTARESS name for the considered instrument configuration.
- Returns:
cen_wav_ord (float, array) – central wavelength of each spectrograph order (in A)
- return_edge_wav_ord(inst)[source]#
Orders edge wavelengths
Returns edge wavelengths of each spectrograph order.
- Parameters:
inst (str) – ANTARESS name for the considered instrument configuration.
- Returns:
edge_wav_ord (float, array 2 x n_orders) – edge wavelengths of each spectrograph order (in A)
- return_pix_size(inst)[source]#
Spectrograph sampling
Returns width of detector pixel in rv space (km/s).
\[\Delta \lambda = \lambda_\mathrm{ref} \Delta v/c\]- Parameters:
TBD
- Returns:
TBD
- resamp_st_prof_tab(inst, vis, isub, fixed_args, gen_dic, nexp, rv_osamp_line_mod)[source]#
Resampled spectral profile table
Defines resampled spectral grid for line profile calculations. Theoretical profiles are directly calculated at the requested resolution, measured profiles are extracted at their native resolution.
- Parameters:
inst (str) – Instrument considered.
vis (str) – Visit considered.
isub (int) – Index of the exposure considered.
fixed_args (dict) – Parameters of the profiles considered.
gen_dic (dict) – General dictionary.
nexp (int) – Number of exposures in the visit considered.
rv_osamp_line_mode (float) – RV-space oversampling factor.
- Returns:
TBD
- def_st_prof_tab(inst, vis, isub, args)[source]#
Spectral profile table attribution
Attributes original or resampled spectral grid for line profile calculations.
- Parameters:
TBD
- Returns:
TBD
- return_resolv(inst)[source]#
Spectral resolving power
Returns resolving power of a given spectrograph.
- Parameters:
inst (str) – Instrument / spectrograph considered.
- Returns:
inst_res (float) – Resolving power of the spectrograph.
- calc_FWHM_inst(inst, w_c)[source]#
Spectral resolution
Returns FWHM of a Gaussian approximating the LSF for a given resolving power, in rv or wavelength space
\[\begin{split}\Delta v &= c / R \\ \Delta \lambda &= \lambda_\mathrm{ref}/R = \lambda_\mathrm{ref} \Delta v/c\end{split}\]- Parameters:
TBD
- Returns:
TBD
- get_FWHM_inst(inst, fixed_args, cen_bins)[source]#
Effective spectral resolution
Returns FWHM relevant to convolve the processed data
in rv space for analytical profiles
in wavelength space for theoretical profiles
disabled if measured profiles as used as proxy for intrinsic profiles
- Parameters:
TBD
- Returns:
TBD
- convol_prof(prof_in, cen_bins, FWHM)[source]#
Instrumental convolution
Convolves input profile with spectrograph LSF. Profile must be defined on a uniform spectral grid.
- Parameters:
prof_in (array, float) – original spectral profile.
cen_bins (array, float) – wavelength grid over which prof_in is defined.
FWHM (float) – width of the Gaussian LSF used to convolve prof_in.
- Returns:
prof_conv (array, float) – convolved spectral profile.