Visible to Intel only — GUID: GUID-2569D63F-43CB-4CB5-88F4-CE828ACE57FE
Visible to Intel only — GUID: GUID-2569D63F-43CB-4CB5-88F4-CE828ACE57FE
vslConvSetDecimation/vslCorrSetDecimation
Changes the value of the parameter decimation in the convolution or correlation task descriptor.
Syntax
status = vslconvsetdecimation(task, decimation)
status = vslcorrsetdecimation(task, decimation)
Include Files
- mkl.fi, mkl_vsl.f90
Input Parameters
Name |
Type |
Description |
---|---|---|
task |
INTEGER*4 task(2) for vslcorrsetdecimation TYPE(VSL_CONV_TASK) for vslconvsetdecimation TYPE(VSL_CORR_TASK) for vslcorrsetdecimation |
Pointer to the task descriptor. |
decimation |
INTEGER, DIMENSION (*) |
New value of the parameter decimation. |
Output Parameters
Name |
Type |
Description |
---|---|---|
status |
INTEGER |
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 vslSetDecimation routines.