LALPulsar  6.1.0.1-c9a8ef6
SimulatePulsarSignal.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2013 Reinhard Prix
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with with program; see the file COPYING. If not, write to the
16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17  * MA 02110-1301 USA
18  */
19 
20 #ifndef _SIMULATEPULSARSIGNAL_H /* Double-include protection. */
21 #define _SIMULATEPULSARSIGNAL_H
22 
23 /* C++ protection. */
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /**
29  * \defgroup SimulatePulsarSignal_h Header SimulatePulsarSignal.h
30  * \ingroup lalpulsar_inject
31  * \author Reinhard Prix
32  * \date 2004, 2013
33  *
34  * \brief New pulsar signal-generation routines
35  */
36 /** @{ */
37 
38 #include <lal/GeneratePulsarSignal.h>
39 
40 /*---------- Global variables ----------*/
41 
42 /*---------- Type definitions ----------*/
43 
44 /* ---------- Function prototypes ---------- */
45 REAL4TimeSeries *XLALSimulateExactPulsarSignal( const PulsarSignalParams *params );
46 
47 /** @} */
48 
49 #ifdef __cplusplus
50 }
51 #endif
52 /* C++ protection. */
53 
54 #endif /* Double-include protection. */
XLALSimulateExactPulsarSignal
REAL4TimeSeries * XLALSimulateExactPulsarSignal(const PulsarSignalParams *params)
Simulate a pulsar signal to best accuracy possible.
Definition: SimulatePulsarSignal.c:129
PulsarSignalParams
Input parameters to GeneratePulsarSignal(), defining the source and the time-series.
Definition: GeneratePulsarSignal.h:279