Module IIRFilter.c

Detailed Description

Computes an instant-by-instant IIR filter response.

Author

Creighton, T. D.

Description

These functions pass a time-domain datum to an object *filter of type REAL4IIRFilter or REAL8IIRFilter, and return the filter response. This is done using the auxiliary data series formalism described in Header IIRFilter.h.

There are two pairs of routines in this module. The functions LALIIRFilterREAL4() and LALIIRFilterREAL8() conform to the LAL standard, with status handling and error trapping; the input datum is passed in as input and the response is returned in *output. The functions LALSIIRFilter() and LALDIIRFilter() are non-standard lightweight routines, which may be more suitable for multiple callings from the inner loops of programs; they have no status handling or error trapping. The input datum is passed in by the variable x, and the response is returned through the function's return statement.

Prototypes
void	LALIIRFilterREAL4 (LALStatus *stat, REAL4 *output, REAL4 input, REAL4IIRFilter *filter)
	WARNING: THIS FUNCTION IS OBSOLETE. More...
void	LALIIRFilterREAL8 (LALStatus *stat, REAL8 *output, REAL8 input, REAL8IIRFilter *filter)
	WARNING: THIS FUNCTION IS OBSOLETE. More...
REAL4	LALSIIRFilter (REAL4 x, REAL4IIRFilter *filter)
	WARNING: THIS FUNCTION IS OBSOLETE. More...
REAL8	XLALIIRFilterREAL8 (REAL8 x, REAL8IIRFilter *filter)
REAL4	XLALIIRFilterREAL4 (REAL4 x, REAL8IIRFilter *filter)

Function Documentation

LALIIRFilterREAL4()

void LALIIRFilterREAL4	(	LALStatus *	stat,
		REAL4 *	output,
		REAL4	input,
		REAL4IIRFilter *	filter
	)

WARNING: THIS FUNCTION IS OBSOLETE.

Deprecated:

Definition at line 55 of file IIRFilter.c.

LALIIRFilterREAL8()

void LALIIRFilterREAL8	(	LALStatus *	stat,
		REAL8 *	output,
		REAL8	input,
		REAL8IIRFilter *	filter
	)

WARNING: THIS FUNCTION IS OBSOLETE.

Deprecated:

Definition at line 112 of file IIRFilter.c.

LALSIIRFilter()

REAL4 LALSIIRFilter	(	REAL4	x,
		REAL4IIRFilter *	filter
	)

WARNING: THIS FUNCTION IS OBSOLETE.

Deprecated:

Definition at line 143 of file IIRFilter.c.

XLALIIRFilterREAL8()

REAL8 XLALIIRFilterREAL8	(	REAL8	x,
		REAL8IIRFilter *	filter
	)

See also

See Module IIRFilter.c for documentation

Definition at line 182 of file IIRFilter.c.

XLALIIRFilterREAL4()

REAL4 XLALIIRFilterREAL4	(	REAL4	x,
		REAL8IIRFilter *	filter
	)

See also

See Module IIRFilter.c for documentation

Definition at line 220 of file IIRFilter.c.