SetDecimation

Changes the value of the parameter decimation in the convolution or correlation task descriptor.

Syntax

Fortran:

status = vslconvsetdecimation(task, decimation)

status = vslcorrsetdecimation(task, decimation)

status = vslConvSetDecimation(task, decimation);

status = vslCorrSetDecimation(task, decimation);

Include Files

The FORTRAN 77 interfaces are specified in the mkl_vsl.f77 include file, the Fortran 90 interfaces are specified in the mkl_vsl.f90 include file, and the C interfaces are specified in the mkl_vsl_functions.h include file.

Input Parameters

Name	Type	Description
task	FORTRAN 77: INTEGER4 task(2) for vslconvsetdecimation INTEGER4 task(2) for vslcorrsetdecimation Fortran 90: TYPE(VSL_CONV_TASK) for vslconvsetdecimation TYPE(VSL_CORR_TASK) for vslcorrsetdecimation C: VSLConvTaskPtr for vslConvSetDecimation VSLCorrTaskPtr for vslCorrSetDecimation	Pointer to the task descriptor.
decimation	FORTRAN 77: INTEGER Fortran 90: INTEGER, DIMENSION (*) C: const int[]	New value of the parameter decimation.

Name

Type

Description

task

FORTRAN 77: INTEGER*4 task(2) for vslconvsetdecimation

INTEGER*4 task(2) for vslcorrsetdecimation

Fortran 90: TYPE(VSL_CONV_TASK) for vslconvsetdecimation

TYPE(VSL_CORR_TASK) for vslcorrsetdecimation

C: VSLConvTaskPtr for vslConvSetDecimation

VSLCorrTaskPtr for vslCorrSetDecimation

Pointer to the task descriptor.

decimation

FORTRAN 77: INTEGER

Fortran 90: INTEGER, DIMENSION (*)

C: const int[]

New value of the parameter decimation.

Output Parameters

Name	Type	Description
status	FORTRAN 77: INTEGER Fortran 90: INTEGER C: int	Current status of the task.

Name

Type

Description

status

FORTRAN 77: INTEGER

Fortran 90: INTEGER

C: int

Current status of the task.

Description

The routine sets the value of the parameter decimation for the operation of convolution or correlation. This parameter determines how to thin out the mathematical result of convolution or correlation before writing it into the output data array. For example, in a one-dimensional case, if decimation = d > 1, only every d-th element of the mathematical result is written to the output array z. In a multidimensional case, decimation is an array of indices and its length is equal to the number of dimensions specified by the parameter dims. For more information about the definition and effect of this parameter, see Data Allocation.

During the initial task descriptor construction, the default value for decimation is undefined and this parameter is not used. Therefore the only way to set and use the decimation parameter is via assigning it some value by one of the SetDecimation routines.