filter_2d (MathScript RT Module Function)

LabVIEW 2012 MathScript RT Module Help

Edition Date: June 2012

Part Number: 373123C-01

»View Product Info

Owning Class: filter implementation

Requires: MathScript RT Module

Syntax

y = filter_2d(f, x)

y = filter_2d(f, x, shape)

Applies a two-dimensional FIR filter.

Name

Description

Specifies the 2D FIR filter to use. f is a 2D array of real or complex, double-precision, floating-point numbers.

Specifies the signal to filter. x is a 2D array of real or complex, double-precision, floating-point numbers.

shape

Specifies the size of the filtered signal. shape is a string that accepts the following values.

'full'	Returns the full two-dimensional convolution. y is larger than x.
'same' (default)	Returns the central part of the convolution. y is the same size as x.
'valid'	Returns only the parts of the convolution that LabVIEW computes without zero-padded edges. y is smaller than x.

Name	Description
y	Returns the filtered signal. y is a 2D array of real or complex, double-precision, floating-point numbers.

The following table lists the support characteristics of this function.

Supported in the LabVIEW Run-Time Engine	Yes
Supported on RT targets	Yes
Suitable for bounded execution times on RT	Not characterized

F = rand(2);
X = rand(4);
Y = filter_2d(F, X, 'full')