Table of contents

General

• Analysis algorithms Collection of analysis algorithms
  • Algorithm Libraries Main algorithm library.
  • Averaging algorithms Averaging.
    • Constants and flags for Averaging Routines. Constants and Flags
    • Functions for Averaging. Functions
  • Common types of the algorithm library Common types and defines.
    • Complex data types.
  • Data Preprocessing Algorithms Preprocessing.
    • Functions.
    • Types.
  • Decimation Algorithms Decimation.
    • Functions.
  • FFT algorithms Fast Fourier transformation.
    • Constants and flags for FFT Routines. Constants and Flags
      • Flags to determine powerspectrum routine
      • Flags to select output data format for powerspectrum function
      • Flags to select the mode of psGen. The mode flag is one
    • FFT parameter type. FFT parameter type
    • Spectral analysis Functions. Functions
  • LU Decomposition Lower/upper triangular matrix decomposition.
  • Numerical and physical constants Constants and Flags.
    • Flags to select input data type. Input data type.
    • Numerical Constants. Numerical Constants.
  • Random Number Utilities Generates random numbers.
    • Constants and flags.
    • Data types.
    • Functions.
  • Signal processing utility functions Signal processing.
  • Swept Sine Algorithms Swept Sine.
    • Constants and flags.
    • Functions.
  • Time Conversion API Converts between UTC and TAI
    • Constants and flags. Constants and flags
    • Data types. Data types
    • Functions. Functions
  • Up-sampling Algorithms Up sampling.
    • Functions.
  • Windowing Functions. Generates data windows.
    • Constants and flags for windowing routines. Constants and Flags.
      • Flag to select detrending
      • Flags to select data windowing
    • Functions.

Functions, Macros

• (*PartitionDataOut) Callback routine for output data
• avg This function averages real or complex data arrays
• calcTrailcoeff Calculates the trailing coefficients, given delta
• coherence Coherence function
• create_plan Creates an FFT plan
• crossSpect Cross Spectrum Function
• dataRotator Rotates the FFT output data array
• decimate Decimate time series by powers of 2
• decimationFilterName decimation filter name
• fabs Overloads fabs for complex numbers
• fftToPs Power spectrum function
• firphase FIR linear phase factor
• freePreproc Free preprocessing parameters
• getNextLeap Returns the next leap second from the internal table
• htonTAI Converts a TAI variable in nsec units into a network portable form
• imul Matrix inversion and multiplication
• initPreproc initialize preprocessing parameters
• inverse Matrix inversion
• isitapoweroftwo Checks if power of two
• lubksb Back subsitution
• ludcmp LU decomposition
• nrand_filter_r Normal random number generator with band-limit
• nrand_r Normal random number generator
• nrandv_r Normal random vector generator
• nrMatrix Matrix type of Numerical Receipes
• nrMatrixFree Frees a Numerical Receipes matrix type
• ntohTAI Converts a TAI variable from network portable form into one with nsec units
• powerspectrum Power spectrum function
• preprocess preprocessing function
• psDataPack Rearranges output data
• psGen FFT function
• rand_filter Sets the filter coefficients for a random number generator
• sDataCopy Data copy with selection and binning
• sDotProd Dot product of two vectors
• sineAnalyze Calculates amplitude & phase of a sine wave in time series data
• sMixdown Heterodyne a time series of real or imaginary data
• ssCoherence Calculates the coherence between two swept sine channels
• stepup Up sampling of time series data
• sweptSineNpts Calculates number of points needed by sineAnalyze.c
• TAInow Returns the current atomci time in nsec
• TAInsec Converts TAI from a broken down format into one with nsec units
• TAIntoUTC Converts TAI (international atomic time) to UTC (coordinated universal time)
• TAIsec Converts TAI from a format with nsec units into one with sec units
• TAItoUTC Converts TAI (international atomic time) to UTC (coordinated universal time)
• timedelay Delay a time series
• urand_filter_r Uniform random number generator with band-limit
• urand_r Reetrant uniform random number generator
• urandv_r Uniform random vector generator
• UTCtoTAI Converts UTC (coordinated universal time) to TAI (international atomic time)
• UTCtoTAIn Converts UTC (coordinated universal time) to TAI (international atomic time)
• winCoeffGen This function generates a set of windowing coefficients for a data set of a given length using one of various windowing functions
• windowData This function multiplies a data set by a windowing function
• zAdd Complex addition
• zConj Complex conjugation
• zMean Mean of a vector
• zMultply Complex multiplication

Variables

• nsec_t Denotes a type representing the nsec part of TAI
• tainsec_t Denotes a type representing TAI in nsec
• taisec_t Denotes a type representing TAI in sec

Macros

• _EPOCH One epoch expressed in ns
• _ONEDAY One day expressed in ns
• _ONEHOUR One hour expressed in ns
• _ONESEC One second expressed in ns
• _USE_POSIX_TIMER Compiler flag specifying to use a POSIX timer
• AVG_EXPON_MODULUS Flag to select an exponential average of the amplitude of input data
• AVG_EXPON_SQUARE Flag to select a square sum average of the input data vectors using an exponental weight
• AVG_EXPON_VECTOR Flag to select an exponential average of the input data vectors
• AVG_LINEAR_MODULUS Flag to select a linear average of the amplitude of the input data
• AVG_LINEAR_SQUARE Flag to select a square sum average of the input data vectors
• AVG_LINEAR_VECTOR Flag to select a linear average of the input data vectors
• DATA_COMPLEX Flag to specify complex input data
• DATA_REAL Flag to specify real input data
• EULER_E Euler e
• FFT_FUNC_CROSSCORR Flag to specify cross spectrum output = 2
• FFT_FUNC_FFT Flag to specify fft output = 1
• FFT_FUNC_POWERSPECT Flag to specify power spectrum output = 0
• FFT_FUNC_PSRANDSIMULUS Flag to specify correlation with pseudorandom simulus = 3
• leap_t Denotes a type representing UTC leap seconds
• N_LEAD Number of leading coefficients in sineAnalyze
• NUMBER_OF_EPOCHS Number of epochs within a second
• ONE_PI Pi: alternative spelling
• OUTPUT_AMPPERRTBIN Flag to specify power spectrum output
• OUTPUT_COMPMINUSFTOF Flag to specify complex output, real, imag pairs, freq ordered
• OUTPUT_COMPNATIVE Flag to specify complex output, same ordering as fftw output
• OUTPUT_GDSFORMAT this flag causes output to be written in numerical recipes format (figure 12
• OUTPUT_PSD Flag to specify power spectral density output
• PI Pi
• PS_CLEAN_PLAN Destroys an existing plan
• PS_INIT_ALL Initialize a windowing function and generate a plan, but take no fft
• PS_INIT_ALL_AND_TAKE_FFT Generate an fft having created a plan and a window function
• PS_INIT_PLAN Returns an fftw plan only, no fft generated
• PS_INIT_WIN Initialize a windowing function
• PS_REMOVE_DC Flag to remove the DC term before taking the FFT
• PS_TAKE_FFT Makes an fft with the supplied plan
• PS_USE_MASK Usage mask for above flags
• RAD_PER_DEG radians per degree
• RAND_AM
• RAND_EPS epsilon relative to (0,1) interval
• RAND_IA
• RAND_IM modulus
• RAND_IQ
• RAND_IR
• RAND_NDIV
• RAND_NTAB shuffle table size
• RAND_RNMX 1 - RAND_EPS
• ROOT_TWO root two
• tai_t Denotes a type representing TAI broken down in sec and nsec
• TAIatGPSzero Defines the TAI offset relative to GPS time
• TWO_OVER_PI two over pi
• TWO_PI two times pi
• utc_t Denotes a type representing UTC
• WINDOW_BARTLETT Flag to specify Bartlett windowing = 4
• WINDOW_BMH Flag to specify BMH windowing = 5
• WINDOW_FLATTOP Flag to specify Flattop windowing = 2
• WINDOW_HAMMING Flag to specify Hamming windowing = 6
• WINDOW_HANNING Flag to specify Hanning windowing = 1
• WINDOW_REMOVE_DC Remove the DC partof the time series
• WINDOW_UNIFORM Flag to specify Uniform windowing = 0
• WINDOW_WELCH Flag to specify Welch windowing = 3

Enums, Unions, Structs

• avg_specs Data structure describing teh averaging
• dCmplx Double precision complex number
• fftparam FFT parameter structure
• leap_struct Denotes a struct representing UTC leap seconds
• preproc_t Preprocessing paramater structure
• randBlock Data buffer for reentrant random number generators
• sCmplx Single precision complex number
• tai_struct Denotes a struct representing TAI broken down in sec and nsec

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++