LALPulsar  6.1.0.1-b72065a
Header PulsarDataTypes.h

Detailed Description

Some common useful data-types for pulsar-searches.

Author
Reinhard Prix
Date
2005

Synopsis

#include <lal/PulsarDataTypes.h>

Data Structures

struct  MultiREAL4TimeSeries
 A collection of (multi-IFO) REAL4 time-series. More...
 
struct  MultiREAL8TimeSeries
 A collection of (multi-IFO) REAL8 time-series. More...
 
struct  COMPLEX8FrequencySeriesVector
 A vector of COMPLEX8FrequencySeries. More...
 
struct  COMPLEX16FrequencySeriesVector
 A vector of COMPLEX16FrequencySeries. More...
 
struct  REAL4FrequencySeriesVector
 A vector of REAL4FrequencySeries. More...
 
struct  REAL8FrequencySeriesVector
 A vector of REAL8FrequencySeries. More...
 
struct  PulsarAmplitudeParams
 Type containing the JKS 'amplitude parameters' {h0, cosi, phi0, psi}. More...
 
struct  PulsarSpinRange
 Contains a "spin-range", ie spins \( f^{(k)} \) and corresponding bands \( \Delta f^{(k)} \) at a given (SSB) reference GPS-time \( \tau \) . More...
 
struct  PulsarDopplerParams
 Type containing the 'Doppler-parameters' affecting the time-evolution of the phase. More...
 
struct  transientWindow_t
 Struct defining one transient window instance. More...
 
struct  PulsarParams
 Type defining the parameters of a pulsar-source of CW Gravitational waves. More...
 
struct  PulsarCandidate
 Type containing a "candidate": parameter-space point with estimated errors and Fstat-value/significance. More...
 

Typedefs

typedef REAL8 PulsarAmplitudeVect[4]
 Struct for 'canonical' coordinates in amplitude-params space A^mu = {A1, A2, A3, A4}. More...
 
typedef REAL8 PulsarSpins[PULSAR_MAX_SPINS]
 Typedef for fixed-size array holding GW frequency and derivatives fk = d^k Freq/dt^k|(tau_ref) More...
 

Enumerations

enum  transientWindowType_t { TRANSIENT_NONE = 0 , TRANSIENT_RECTANGULAR = 1 , TRANSIENT_EXPONENTIAL , TRANSIENT_LAST }
 Struct to define parameters of a 'transient window' to be applied to obtain transient signals. More...
 

Macros

#define PULSAR_MAX_SPINS   7
 maximal number of spin-parameters (Freq + spindowns) we can handle More...
 
#define PULSAR_MAX_DETECTORS   10
 maximal number of detectors we can handle (for static arrays of detector quantities) More...
 

Typedef Documentation

◆ PulsarAmplitudeVect

typedef REAL8 PulsarAmplitudeVect[4]

Struct for 'canonical' coordinates in amplitude-params space A^mu = {A1, A2, A3, A4}.

Definition at line 124 of file PulsarDataTypes.h.

◆ PulsarSpins

typedef REAL8 PulsarSpins[PULSAR_MAX_SPINS]

Typedef for fixed-size array holding GW frequency and derivatives fk = d^k Freq/dt^k|(tau_ref)

Definition at line 127 of file PulsarDataTypes.h.

Enumeration Type Documentation

◆ transientWindowType_t

Struct to define parameters of a 'transient window' to be applied to obtain transient signals.

Enumerator
TRANSIENT_NONE 

Note: in this case the window-parameters will be ignored, and treated as rect={data}, i.e.

a simple rectangular window covering all the data => this should always reproduce the standard F-statistic computation.

TRANSIENT_RECTANGULAR 

standard rectangular window covering [t0, t0+tau]

TRANSIENT_EXPONENTIAL 

exponentially decaying window e^{-t0/tau} starting at t0.

Note: we'll truncate this at some small (eg 3x) e-folding TRANSIENT_EXP_EFOLDING

TRANSIENT_LAST 

Definition at line 157 of file PulsarDataTypes.h.

Macro Definition Documentation

◆ PULSAR_MAX_SPINS

#define PULSAR_MAX_SPINS   7

maximal number of spin-parameters (Freq + spindowns) we can handle

Definition at line 108 of file PulsarDataTypes.h.

◆ PULSAR_MAX_DETECTORS

#define PULSAR_MAX_DETECTORS   10

maximal number of detectors we can handle (for static arrays of detector quantities)

Definition at line 112 of file PulsarDataTypes.h.