LALPulsar  6.1.0.1-89842e6
GeneratePulsarSignal.h File Reference

Prototypes

REAL4TimeSeriesXLALGeneratePulsarSignal (const PulsarSignalParams *params)
 Generate a time-series at the detector for a given pulsar. More...
 
REAL4TimeSeriesXLALGenerateLineFeature (const PulsarSignalParams *params)
 Generate a REAL4TimeSeries containing a sinusoid with amplitude 'h0', frequency 'Freq-fHeterodyne' and initial phase 'phi0'. More...
 
SFTVectorXLALSignalToSFTs (const REAL4TimeSeries *signalvec, const SFTParams *params)
 Turn the given time-series into SFTs and add noise if given. More...
 
int XLALConvertGPS2SSB (LIGOTimeGPS *SSBout, LIGOTimeGPS GPSin, const PulsarSignalParams *params)
 Convert earth-frame GPS time into barycentric-frame SSB time for given source. More...
 
int XLALConvertSSB2GPS (LIGOTimeGPS *GPSout, LIGOTimeGPS SSBin, const PulsarSignalParams *params)
 Convert barycentric frame SSB time into earth-frame GPS time. More...
 
int XLALAddGaussianNoise (REAL4TimeSeries *inSeries, REAL4 sigma, INT4 seed)
 Generate Gaussian noise with standard-deviation sigma, add it to inSeries. More...
 
void XLALDestroyMultiREAL4TimeSeries (MultiREAL4TimeSeries *multiTS)
 Destroy a MultiREAL4TimeSeries, NULL-robust. More...
 
void XLALDestroyMultiREAL8TimeSeries (MultiREAL8TimeSeries *multiTS)
 Destroy a MultiREAL8TimeSeries, NULL-robust. More...
 
void LALGeneratePulsarSignal (LALStatus *status, REAL4TimeSeries **signalvec, const PulsarSignalParams *params)
 
void LALSignalToSFTs (LALStatus *status, SFTVector **outputSFTs, const REAL4TimeSeries *signalvec, const SFTParams *params)
 
void LALComputeSkyAndZeroPsiAMResponse (LALStatus *status, SkyConstAndZeroPsiAMResponse *output, const SFTandSignalParams *params)
 /deprecated Move to attic? Wrapper for LALComputeSky() and LALComputeDetAMResponse() that finds the sky constants and \( F_+ \) and \( F_\times \) for use with LALFastGeneratePulsarSFTs(). More...
 
void LALFastGeneratePulsarSFTs (LALStatus *status, SFTVector **outputSFTs, const SkyConstAndZeroPsiAMResponse *input, const SFTandSignalParams *params)
 Fast generation of Fake SFTs for a pure pulsar signal. More...
 

Go to the source code of this file.

Data Structures

struct  PulsarSignalParams
 Input parameters to GeneratePulsarSignal(), defining the source and the time-series. More...
 
struct  SFTParams
 Parameters defining the SFTs to be returned from LALSignalToSFTs(). More...
 
struct  SFTandSignalParams
 Parameters defining the pulsar signal and SFTs used by LALFastGeneratePulsarSFTs(). More...
 
struct  SkyConstAndZeroPsiAMResponse
 Sky Constants and beam pattern response functions used by LALFastGeneratePulsarSFTs(). More...
 

Macros

Error codes
#define GENERATEPULSARSIGNALH_ENULL   1
 Arguments contained an unexpected null pointer. More...
 
#define GENERATEPULSARSIGNALH_ENONULL   2
 Output pointer is not NULL. More...
 
#define GENERATEPULSARSIGNALH_EMEM   3
 Out of memory. More...
 
#define GENERATEPULSARSIGNALH_ESAMPLING   4
 Waveform sampling interval too large. More...
 
#define GENERATEPULSARSIGNALH_ESSBCONVERT   5
 SSB->GPS iterative conversion failed. More...
 
#define GENERATEPULSARSIGNALH_ESYS   6
 System error, probably while File I/O. More...
 
#define GENERATEPULSARSIGNALH_ETIMEBOUND   7
 Timestamp outside of allowed time-interval. More...
 
#define GENERATEPULSARSIGNALH_ENUMSFTS   8
 Inconsistent number of SFTs in timestamps and noise-SFTs. More...
 
#define GENERATEPULSARSIGNALH_EINCONSBAND   9
 Inconsistent values of sampling-rate and Tsft. More...
 
#define GENERATEPULSARSIGNALH_ENOISEDELTAF   10
 Frequency resolution of noise-SFTs inconsistent with signal. More...
 
#define GENERATEPULSARSIGNALH_ENOISEBAND   11
 Frequency band of noise-SFTs inconsistent with signal. More...
 
#define GENERATEPULSARSIGNALH_ENOISEBINS   12
 Frequency bins of noise-SFTs inconsistent with signal. More...
 
#define GENERATEPULSARSIGNALH_EBADCOORDS   13
 Current code requires sky position in equatorial coordinates. More...
 
#define GENERATEPULSARSIGNALH_ELUTS   14
 Lookup tables (LUTs) for trig functions must be defined on domain -2pi to 2pi inclusive. More...
 
#define GENERATEPULSARSIGNALH_EDTERMS   15
 Dterms must be greater than zero and less than or equal to half the number of SFT bins. More...
 
#define GENERATEPULSARSIGNALH_EINPUT   16
 Invalid input-arguments to function. More...
 
#define GENERATEPULSARSIGNALH_EDETECTOR   17
 Unknown detector-name. More...