|
CR2RE Pipeline Reference Manual 1.6.2
|
Functions | |
| hdrl_parameter * | hdrl_response_telluric_evaluation_parameter_create (const hdrl_spectrum1Dlist *telluric_models, hdrl_data_t w_step, cpl_size half_win, cpl_boolean normalize, cpl_boolean shift_in_log_scale, const cpl_bivector *quality_areas, const cpl_bivector *fit_areas, hdrl_data_t lmin, hdrl_data_t lmax) |
| ctor for the hdrl_parameter for the telluric evaluation | |
| hdrl_parameter * | hdrl_response_fit_parameter_create (const cpl_size radius, const cpl_array *fit_points, const hdrl_data_t wrange, const cpl_bivector *high_abs_regions) |
| ctor for the hdrl_parameter for the final interpolation of the response | |
| hdrl_response_result * | hdrl_response_compute (const hdrl_spectrum1D *obs_s, const hdrl_spectrum1D *ref_s, const hdrl_spectrum1D *E_x, const hdrl_parameter *telluric_par, const hdrl_parameter *velocity_par, const hdrl_parameter *calc_par, const hdrl_parameter *fit_par) |
| Computation of the response. | |
| const hdrl_spectrum1D * | hdrl_response_result_get_final_response (const hdrl_response_result *res) |
| Getter for the final response contained inside the hdrl_response_result. | |
| const hdrl_spectrum1D * | hdrl_response_result_get_selected_response (const hdrl_response_result *res) |
| Getter for the selected response contained inside the hdrl_response_result. | |
| const hdrl_spectrum1D * | hdrl_response_result_get_raw_response (const hdrl_response_result *res) |
| Getter for the raw response contained inside the hdrl_response_result. | |
| const hdrl_spectrum1D * | hdrl_response_result_get_corrected_obs_spectrum (const hdrl_response_result *res) |
| Getter for the corrected observed spectrum contained in hdrl_response_result. | |
| cpl_size | hdrl_response_result_get_best_telluric_model_idx (const hdrl_response_result *res) |
| Getter of the index of the telluric model used for telluric correction contained in hdrl_response_result. | |
| hdrl_data_t | hdrl_response_result_get_avg_diff_from_1 (const hdrl_response_result *res) |
| Getter of the value |mean - 1|, where mean is the average of the ratio between the corrected observed spectrum and its smoothed fit. | |
| hdrl_data_t | hdrl_response_result_get_stddev (const hdrl_response_result *res) |
| Getter of the standard deviation of the ratio between the corrected observed spectrum and its smoothed fit. | |
| hdrl_data_t | hdrl_response_result_get_telluric_shift (const hdrl_response_result *res) |
| Getter of the shift applied to the telluric model. | |
| hdrl_data_t | hdrl_response_result_get_doppler_shift (const hdrl_response_result *res) |
| Getter of the doppler shift used to correct the model. | |
| void | hdrl_response_result_delete (hdrl_response_result *res) |
| Destructor for hdrl_response_result. | |
| hdrl_response_result * hdrl_response_compute | ( | const hdrl_spectrum1D * | obs_s, |
| const hdrl_spectrum1D * | ref_s, | ||
| const hdrl_spectrum1D * | E_x, | ||
| const hdrl_parameter * | telluric_par, | ||
| const hdrl_parameter * | velocity_par, | ||
| const hdrl_parameter * | calc_par, | ||
| const hdrl_parameter * | fit_par | ||
| ) |
Computation of the response.
| obs_s | Observed spectrum |
| ref_s | Reference std star spectrum |
| E_x | Atmospheric Extinction |
| telluric_par | Telluric correction parameter, NULL if telluric correction is skipped. See hdrl_response_telluric_evaluation_parameter_create for details. |
| velocity_par | Doppler shift estimation and compensation. NULL if compensation has to be skipped. See hdrl_spectrum1D_shift_fit_parameter_create for more details. |
| calc_par | Parameter for the core computation of the response, e.g. exposure time. See hdrl_response_parameter_create for more details. |
| fit_par | Parameter for the final interpolation of the response, see hdrl_response_fit_parameter_create for more details. |
Possible cpl-error-code set in this function:
Definition at line 459 of file hdrl_response.c.
References hdrl_parameter_delete(), hdrl_response_core_compute(), hdrl_spectrum1D_compute_shift_fit(), hdrl_spectrum1D_delete(), hdrl_spectrum1D_get_wavelength(), hdrl_spectrum1D_resample_interpolate_parameter_create(), and hdrl_spectrum1D_resample_on_array().
| hdrl_parameter * hdrl_response_fit_parameter_create | ( | const cpl_size | radius, |
| const cpl_array * | fit_points, | ||
| const hdrl_data_t | wrange, | ||
| const cpl_bivector * | high_abs_regions | ||
| ) |
ctor for the hdrl_parameter for the final interpolation of the response
| radius | Radius of the median filter used to smooth the response before the final interpolation |
| fit_points | Median points where the fit will be calculated |
| wrange | Range around the median point where the median is calculated |
| high_abs_regions | High absorption regions that should be skipped when calculating the fit. If NULL no skipping is done. |
Possible cpl-error-code set in this function:
Definition at line 403 of file hdrl_response.c.
| void hdrl_response_result_delete | ( | hdrl_response_result * | res | ) |
Destructor for hdrl_response_result.
| res | hdrl_response_result to be destroyed |
Definition at line 757 of file hdrl_response.c.
References hdrl_spectrum1D_delete().
| hdrl_data_t hdrl_response_result_get_avg_diff_from_1 | ( | const hdrl_response_result * | res | ) |
Getter of the value |mean - 1|, where mean is the average of the ratio between the corrected observed spectrum and its smoothed fit.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 684 of file hdrl_response.c.
| cpl_size hdrl_response_result_get_best_telluric_model_idx | ( | const hdrl_response_result * | res | ) |
Getter of the index of the telluric model used for telluric correction contained in hdrl_response_result.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 662 of file hdrl_response.c.
| const hdrl_spectrum1D * hdrl_response_result_get_corrected_obs_spectrum | ( | const hdrl_response_result * | res | ) |
Getter for the corrected observed spectrum contained in hdrl_response_result.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 643 of file hdrl_response.c.
| hdrl_data_t hdrl_response_result_get_doppler_shift | ( | const hdrl_response_result * | res | ) |
Getter of the doppler shift used to correct the model.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 744 of file hdrl_response.c.
| const hdrl_spectrum1D * hdrl_response_result_get_final_response | ( | const hdrl_response_result * | res | ) |
Getter for the final response contained inside the hdrl_response_result.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 586 of file hdrl_response.c.
| const hdrl_spectrum1D * hdrl_response_result_get_raw_response | ( | const hdrl_response_result * | res | ) |
Getter for the raw response contained inside the hdrl_response_result.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 625 of file hdrl_response.c.
| const hdrl_spectrum1D * hdrl_response_result_get_selected_response | ( | const hdrl_response_result * | res | ) |
Getter for the selected response contained inside the hdrl_response_result.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 606 of file hdrl_response.c.
| hdrl_data_t hdrl_response_result_get_stddev | ( | const hdrl_response_result * | res | ) |
Getter of the standard deviation of the ratio between the corrected observed spectrum and its smoothed fit.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 706 of file hdrl_response.c.
| hdrl_data_t hdrl_response_result_get_telluric_shift | ( | const hdrl_response_result * | res | ) |
Getter of the shift applied to the telluric model.
| res | hdrl_response_result |
Possible cpl-error-code set in this function:
Definition at line 726 of file hdrl_response.c.
| hdrl_parameter * hdrl_response_telluric_evaluation_parameter_create | ( | const hdrl_spectrum1Dlist * | telluric_models, |
| hdrl_data_t | w_step, | ||
| cpl_size | half_win, | ||
| cpl_boolean | normalize, | ||
| cpl_boolean | shift_in_log_scale, | ||
| const cpl_bivector * | quality_areas, | ||
| const cpl_bivector * | fit_areas, | ||
| hdrl_data_t | lmin, | ||
| hdrl_data_t | lmax | ||
| ) |
ctor for the hdrl_parameter for the telluric evaluation
| telluric_models | The available telluric models |
| w_step | Sampling step to use when upsampling model and observed spectrum to calculate the cross correlations |
| half_win | Half the search window to be used to find the peak of the cross correlation |
| normalize | CPL_TRUE if the cross correlation should be normalized, CPL_FALSE otherwise |
| shift_in_log_scale | CPL_TRUE if the cross correlation has to be calculated in logarithmic scale. CPL_FALSE otherwise. |
| quality_areas | Areas where the quality of the fit of the telluric model has to be evaluated. |
| fit_areas | Areas where the median points are extracted from, in order to generate the final quality parameters of the telluric model |
| lmin | Minimum wavelength used to calculate the cross-correlation (in log scale if shift_in_log_scale = TRUE) |
| lmax | Maximum wavelength used to calculate the cross-correlation (in log scale if shift_in_log_scale = TRUE) |
Possible cpl-error-code set in this function:
Definition at line 347 of file hdrl_response.c.
References hdrl_spectrum1Dlist_duplicate().