LAL  7.5.0.1-b72065a

Tests time-domain high- and low-pass filters. More...

Detailed Description

Tests time-domain high- and low-pass filters.

Author
Creighton, T. D.

Usage

BandPassTest [-d debuglevel] [-i infile | -n npts dt offset] [-o outfile]
[-f f1 f2 a1 a2 order]
static double f(double theta, double y, double xi)
Definition: XLALMarcumQ.c:258

Description

This program applies a Butterworth time-domain low-pass or high-pass filter to a time series, using the routine LALDButterworthREAL4TimeSeries(). The following option flags are accepted:

  • [-d] Changes the default debug level from 0 to debuglevel.
  • [-i] Reads the input time series from infile using the routine LALSReadTSeries(); see Header StreamInput.h for a description of the file format.
  • [-n] Generates an input time series of length npts and sampling interval dt, containing just an impulse at sample index offset. If the -i option is also given, it overrides this option. If neither are given, -n 4096 1.0 1024 is assumed.
  • [-o] Writes the output time series to outfile, using the routine LALSWriteTSeries(); see StreamOutput_h for a description of the file format. If not specified, the routines are exercised, but no output is written.
  • [-f] Sets the filter to have attenuation a1 and a2 at frequencies f1 and f2, with a maximum filter order of order; see Module ButterworthTimeSeries.c for a description of how these values are interpreted. If not specified, -f 0.01 0.015 0.9 0.1 20 is assumed.

Definition in file BandPassTest.c.

Go to the source code of this file.

Macros

Error Codes
#define BANDPASSTESTC_ENORM   0
 Normal exit. More...
 
#define BANDPASSTESTC_ESUB   1
 Subroutine failed. More...
 
#define BANDPASSTESTC_EARG   2
 Error parsing arguments. More...
 
#define BANDPASSTESTC_EBAD   3
 Bad argument values. More...
 
#define BANDPASSTESTC_EFILE   4
 Could not open file. More...
 

Macro Definition Documentation

◆ BANDPASSTESTC_ENORM

#define BANDPASSTESTC_ENORM   0

Normal exit.

Definition at line 75 of file BandPassTest.c.

◆ BANDPASSTESTC_ESUB

#define BANDPASSTESTC_ESUB   1

Subroutine failed.

Definition at line 76 of file BandPassTest.c.

◆ BANDPASSTESTC_EARG

#define BANDPASSTESTC_EARG   2

Error parsing arguments.

Definition at line 77 of file BandPassTest.c.

◆ BANDPASSTESTC_EBAD

#define BANDPASSTESTC_EBAD   3

Bad argument values.

Definition at line 78 of file BandPassTest.c.

◆ BANDPASSTESTC_EFILE

#define BANDPASSTESTC_EFILE   4

Could not open file.

Definition at line 79 of file BandPassTest.c.