LAL  7.5.0.1-bb18dad

Detailed Description

Provides routines to low- or high-pass filter a time series.

Author
Creighton, T. D.

Synopsis

#include <lal/BandPassTimeSeries.h>

The Header BandPassTimeSeries.h provides routines an actual implementation of these utilities to the specific task of high- or low-pass filtering of a data stream. These routines also serve as an example for the more general task of designing time-domain filters with any desired frequency response.

This header covers routines that apply a time-domain low- or high-pass filter to a data series of type <datatype>TimeSeries. Further documentation is given in the individual routines' modules.

Modules

 Module ButterworthTimeSeries.c
 Applies a low- or high-pass Butterworth filter to a time series.
 

Data Structures

struct  PassBandParamStruc
 This structure stores data used for constructing a low- or high-pass filter: either the order and characteristic frequency of the filter, or the frequencies and desired attenuations at the ends of some transition band. More...
 

Files

file  BandPassTest.c
 Tests time-domain high- and low-pass filters.
 

Error Codes

#define BANDPASSTIMESERIESH_ENUL   1
 Unexpected null pointer in arguments. More...
 
#define BANDPASSTIMESERIESH_EBAD   2
 Bad filter parameters. More...
 

Macro Definition Documentation

◆ BANDPASSTIMESERIESH_ENUL

#define BANDPASSTIMESERIESH_ENUL   1

Unexpected null pointer in arguments.

Definition at line 61 of file BandPassTimeSeries.h.

◆ BANDPASSTIMESERIESH_EBAD

#define BANDPASSTIMESERIESH_EBAD   2

Bad filter parameters.

Definition at line 62 of file BandPassTimeSeries.h.