IDL Reference Guide: Procedures and Functions

IR_FILTER

The IR_FILTER function filters data with an infinite impulse response (IIR) or finite impulse response (FIR) filter.

This routine is written in the IDL language. Its source code can be found in the file ir_filter.pro in the lib subdirectory of the IDL distribution.

The form of the filter is given by the following equation:

If the input vector D contains only one element, d₀, the second term of the equation drops out, and the filter is nonrecursive or finite impulse response (FIR). If D contains more than one element, the filter is recursive or infinite impulse response (IIR).

If d₀ is not equal to 1, the routine normalizes the filter coefficients by d₀.

This filter, H(z), would be described in the z-domain by the following equation:

Syntax

Result = IR_FILTER(C [, D], Data [, /DOUBLE])

Return Value

The Result is a vector containing the filtered data.

Arguments

C

A vector defining the numerator coefficients.

D

An optional vector where the first element of D is the scaling factor and the rest of the elements, if any, are scaling factors. If not supplied, the default is [1].

Data

The input data vector to be filtered.

Keywords

DOUBLE

If set, this function returns the filtered data in double precision. The default is to return the data in the precision with which it was entered.

Example

Consider the following transfer function:

The coefficients of the numerator, ordered in ascending powers of z^-1, are

c=[3, 2]  

The coefficients of the denominator, with a d₀ scaling factor of 1, are

d=[2, 0.4]  

The call to the filter function on a data vector data is

filtered_data = IR_FILTER( c, d, data )