High-Level Data Reduction Library: hdrl_spectrum_shift.h Source File

High-Level Data Reduction Library 1.6.0 High-Level data reduction routines for ESO pipelines

Loading...
Searching...
No Matches
hdrl_spectrum_shift.h
Go to the documentation of this file.
1/* $Id: hdrl_spectrum_shift.h,v 0.1 2017-06-06 13:23:28 msalmist Exp $
2 *
3 * This file is part of the HDRL
4 * Copyright (C) 2017 European Southern Observatory
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21/*
22 * $Author: msalmist $
23 * $Date: 2017-06-06 13:23:28 $
24 * $Revision: 0.1 $
25 * $Name: not supported by cvs2svn $
26 */
27
28#ifndef HDRL_SPECTRUM_SHIFT_H
29#define HDRL_SPECTRUM_SHIFT_H
30
31/*-----------------------------------------------------------------------------
32 Includes
33 -----------------------------------------------------------------------------*/
34
35#include "hdrl_spectrum.h"
36
37#include <cpl.h>
38
39CPL_BEGIN_DECLS
40/*-----------------------------------------------------------------------------
41 Functions
42 -----------------------------------------------------------------------------*/
43 hdrl_xcorrelation_result *
44 hdrl_spectrum1D_compute_shift_xcorrelation(const hdrl_spectrum1D * s1,
45 const hdrl_spectrum1D * s2,
46 const cpl_size half_win,
47 const cpl_boolean normalize);
48 hdrl_parameter *
49 hdrl_spectrum1D_shift_fit_parameter_create(const hdrl_data_t wguess, const hdrl_data_t range_wmin,
50 const hdrl_data_t range_wmax, const hdrl_data_t fit_wmin,
51 const hdrl_data_t fit_wmax, const hdrl_data_t fit_half_win);
52
53 hdrl_data_t
54 hdrl_spectrum1D_compute_shift_fit(const hdrl_spectrum1D * obs,
55 const hdrl_parameter * par);
56
57CPL_END_DECLS
58
59#endif
hdrl_data_t
double hdrl_data_t
Definition hdrl_types.h:62
hdrl_spectrum.h
hdrl_parameter
struct _hdrl_parameter_ hdrl_parameter
Definition hdrl_parameter.h:27
hdrl_spectrum1D_shift_fit_parameter_create
hdrl_parameter * hdrl_spectrum1D_shift_fit_parameter_create(const hdrl_data_t wguess, const hdrl_data_t range_wmin, const hdrl_data_t range_wmax, const hdrl_data_t fit_wmin, const hdrl_data_t fit_wmax, const hdrl_data_t fit_half_win)
The function create a hdrl_spectrum1D_shift_parameter to be used in hdrl_spectrum1D_compute_shift_fit...
Definition hdrl_spectrum_shift.c:162
hdrl_spectrum1D_compute_shift_fit
hdrl_data_t hdrl_spectrum1D_compute_shift_fit(const hdrl_spectrum1D *obs, const hdrl_parameter *par)
The function compute the shift due to radial velocity. If wguess is the reference line and wfound is ...
Definition hdrl_spectrum_shift.c:198
hdrl_spectrum1D_compute_shift_xcorrelation
CPL_BEGIN_DECLS hdrl_xcorrelation_result * hdrl_spectrum1D_compute_shift_xcorrelation(const hdrl_spectrum1D *s1, const hdrl_spectrum1D *s2, const cpl_size half_win, const cpl_boolean normalize)
The function computes the shift between the two spectra.
Definition hdrl_spectrum_shift.c:94
hdrl_xcorrelation_result
Definition hdrl_correlation.h:41
hdrl_spectrum1D
Definition hdrl_spectrum_defs.h:44