LALPulsar  6.1.0.1-fe68b98
LFTandTSutils.h File Reference

Prototypes

COMPLEX8TimeSeriesXLALSFTVectorToCOMPLEX8TimeSeries (const SFTVector *sftsIn)
 Turn the given SFTvector into one long time-series, properly dealing with gaps. More...
 
MultiCOMPLEX8TimeSeriesXLALMultiSFTVectorToCOMPLEX8TimeSeries (const MultiSFTVector *multisfts)
 Turn the given multiSFTvector into multiple long COMPLEX8TimeSeries, properly dealing with gaps. More...
 
SFTtypeXLALSFTVectorToLFT (SFTVector *sfts, REAL8 upsampling)
 Turn the given multi-IFO SFTvectors into one long Fourier transform (LFT) over the total observation time. More...
 
int XLALReorderFFTWtoSFT (COMPLEX8Vector *X)
 Change frequency-bin order from fftw-convention to a 'SFT' ie. More...
 
int XLALReorderSFTtoFFTW (COMPLEX8Vector *X)
 Change frequency-bin order from 'SFT' to fftw-convention ie. More...
 
int XLALTimeShiftSFT (SFTtype *sft, REAL8 shift)
 Time-shift the given SFT by an amount of 'shift' seconds, using the frequency-domain expression \( \widetilde{y}(f) = \widetilde{x}(f) \, e^{i 2\pi\,f\,\tau} \) , which shifts \( x(t) \) into \( y(t) = x(t + \tau) \). More...
 
int XLALFrequencyShiftMultiCOMPLEX8TimeSeries (MultiCOMPLEX8TimeSeries *x, const REAL8 shift)
 Multi-detector wrapper for XLALFrequencyShiftCOMPLEX8TimeSeries NOTE: this modifies the MultiCOMPLEX8Timeseries in place. More...
 
int XLALFrequencyShiftCOMPLEX8TimeSeries (COMPLEX8TimeSeries *x, const REAL8 shift)
 Freq-shift the given COMPLEX8Timeseries by an amount of 'shift' Hz, using the time-domain expression y(t) = x(t) * e^(-i 2pi df t), which shifts x(f) into y(f) = x(f + df) More...
 
int XLALSpinDownCorrectionMultiTS (MultiCOMPLEX8TimeSeries *multiTimeSeries, const PulsarDopplerParams *doppler)
 Apply a spin-down correction to the complex8 timeseries using the time-domain expression y(t) = x(t) * e^(-i 2pi sum f_k * (t-tref)^(k+1)),. More...
 
COMPLEX8TimeSeriesXLALDuplicateCOMPLEX8TimeSeries (COMPLEX8TimeSeries *ttimes)
 Duplicates a COMPLEX8TimeSeries structure. More...
 
MultiCOMPLEX8TimeSeriesXLALDuplicateMultiCOMPLEX8TimeSeries (MultiCOMPLEX8TimeSeries *multiTimes)
 Duplicates a MultiCOMPLEX8TimeSeries structure. More...
 
int XLALCopyMultiCOMPLEX8TimeSeries (MultiCOMPLEX8TimeSeries *multiTimesOut, MultiCOMPLEX8TimeSeries *multiTimesIn)
 Copies a MultiCOMPLEX8TimeSeries structure, output must be allocated of identical size as input! More...
 
int XLALCopyCOMPLEX8TimeSeries (COMPLEX8TimeSeries *ts_out, COMPLEX8TimeSeries *ts_in)
 Copies a COMPLEX8TimeSeries structure, output must be allocated of identical size as input! More...
 
void XLALDestroyMultiCOMPLEX8TimeSeries (MultiCOMPLEX8TimeSeries *multiTimes)
 Destroy a MultiCOMPLEX8TimeSeries structure. More...
 
int XLALSincInterpolateCOMPLEX8TimeSeries (COMPLEX8Vector *y_out, const REAL8Vector *t_out, const COMPLEX8TimeSeries *ts_in, UINT4 Dterms)
 Interpolate a given regularly-spaced COMPLEX8 timeseries 'ts_in = x_in(j * dt)' onto new samples 'y_out(t_out)' using windowed Shannon sinc interpolation, windowed to (2*Dterms+1) terms, namely. More...
 
int XLALSincInterpolateCOMPLEX8FrequencySeries (COMPLEX8Vector *y_out, const REAL8Vector *f_out, const COMPLEX8FrequencySeries *fs_in, UINT4 Dterms)
 Interpolate a given regularly-spaced COMPLEX8 frequency-series 'fs_in = x_in( k * df)' onto new samples 'y_out(f_out)' using (complex) Sinc interpolation (obtained from Dirichlet kernel in large-N limit), truncated to (2*Dterms+1) terms, namely. More...
 
SFTtypeXLALSincInterpolateSFT (const SFTtype *sft_in, REAL8 f0Out, REAL8 dfOut, UINT4 numBinsOut, UINT4 Dterms)
 (Complex)Sinc-interpolate an input SFT to an output SFT. More...
 
COMPLEX8VectorXLALrefineCOMPLEX8Vector (const COMPLEX8Vector *in, UINT4 refineby, UINT4 Dterms)
 Interpolate frequency-series to newLen frequency-bins. More...
 
int XLALCompareCOMPLEX8Vectors (VectorComparison *result, const COMPLEX8Vector *x, const COMPLEX8Vector *y, const VectorComparison *tol)
 Compare two COMPLEX8 vectors using various different comparison metrics. More...
 
int XLALCompareREAL4Vectors (VectorComparison *result, const REAL4Vector *x, const REAL4Vector *y, const VectorComparison *tol)
 Compare two REAL4 vectors using various different comparison metrics. More...
 
int XLALCheckVectorComparisonTolerances (const VectorComparison *result, const VectorComparison *tol)
 Check VectorComparison result against specified tolerances, to allow for standardized comparison and reporting. More...
 

Go to the source code of this file.

Data Structures

struct  MultiCOMPLEX8TimeSeries
 Multi-IFO container for COMPLEX8 resampled timeseries. More...
 
struct  VectorComparison
 Struct holding the results of comparing two floating-point vectors (real-valued or complex), using various different comparison metrics. More...
 

Macros

#define NhalfPosDC(N)   ( (UINT4)( N / 2 ) + 1 )
 
#define NhalfNeg(N)   ( (N) - NhalfPosDC(N) ) /* making sure NhalfPosDC(N) + NhalfNeg(N) = N */