MUSE Pipeline Reference Manual  2.1.1
muse_rvcorrect.h
1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim:set sw=2 sts=2 et cin: */
3 /*
4  * This file is part of the MUSE Instrument Pipeline
5  * Copyright (C) 2014 European Southern Observatory
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  */
21 
22 #ifndef MUSE_RVCORRECT_H
23 #define MUSE_RVCORRECT_H
24 
25 /*----------------------------------------------------------------------------*
26  * Includes *
27  *----------------------------------------------------------------------------*/
28 #include <cpl.h>
29 
30 #include "muse_pixtable.h"
31 
32 /*----------------------------------------------------------------------------*
33  * Special variable types *
34  *----------------------------------------------------------------------------*/
35 typedef enum {
36  MUSE_RVCORRECT_NONE = 0,
37  MUSE_RVCORRECT_BARY,
38  MUSE_RVCORRECT_HELIO,
39  MUSE_RVCORRECT_GEO,
40  MUSE_RVCORRECT_UNKNOWN
41 } muse_rvcorrect_type;
42 
43 /*----------------------------------------------------------------------------*
44  * Function prototypes *
45  *----------------------------------------------------------------------------*/
46 muse_rvcorrect_type muse_rvcorrect_select_type(const char *);
47 
48 cpl_error_code muse_rvcorrect(muse_pixtable *, muse_rvcorrect_type);
49 
50 #endif /* MUSE_RVCORRECT_H */
cpl_error_code muse_rvcorrect(muse_pixtable *, muse_rvcorrect_type)
Correct the wavelengths of all pixels of a given pixel table for radial velocity shift.
muse_rvcorrect_type muse_rvcorrect_select_type(const char *)
Select type of radial velocity correction to be done from type string.
Structure definition of MUSE pixel table.