Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference
BatchSetCubicArgs
Sets the parameters of the cubic filter in an initialized specification structure of a batch.
Syntax
IppStatus ippiBatchSetCubicArgs(Ipp32f valueB, Ipp32f valueC, void* pSpec);
Threading Layer (TL) flavor:
IppStatus ippiBatchSetCubicArgs_T(Ipp32f valueB, Ipp32f valueC, void* pSpec);
Include Files
ippi_l.h
The flavor with the _T suffix: ippi_tl.h
Domain Dependencies
Headers: ippcore.h, ippvm.h, ipps.h
Libraries: ippcore.lib, ippvm.lib, ipps.lib
The flavor with the _T suffix additionally requires ippcore_tl.h and ippcore_tl.lib.
Parameters
valueB |
The B parameter of the two-parameter cubic filter, shared by the whole batch. |
valueC |
The C parameter of the two-parameter cubic filter, shared by the whole batch. |
pSpec |
Pointer to the specification structure of the batch, initialized by the Init function of that batch transform, that is to the IppiResizeBatchSpec structure initialized by the ResizeBatchInit_L function for the batch resize, or to the IppiWarpBatchSpec structure initialized by the WarpBatchInit_L function for the batch warp. |
Description
One function serves every batch transform, so the specification structure is passed as a void pointer: the structure of each of them is an opaque type of its own, but all of them carry the parameters of the cubic filter in the same place, and this function writes those parameters alone.
This function replaces the parameters of the two-parameter cubic filter that the Init function of the batch, that is the ResizeBatchInit_L or the WarpBatchInit_L one, stored in pSpec. Use it when the batch is transformed with the IPPI_INTER_CUBIC interpolation method and the default kernel of that function, that is B = 0.0 and C = 0.75, is not the wanted one.
The parameters are used by the IPPI_INTER_CUBIC method only, so the interpolation method of pSpec must be that one. Each of the IPPI_INTER_CUBIC2P_ methods names a predefined kernel, whose parameters the Init function stored, and the methods that are not cubic build no cubic filter at all: for such a batch the function leaves pSpec unchanged and returns the ippStsNoOperation warning.
The specification structure must be initialized before the call and this function does not change any other parameter of it, so it can be called at any point between the Init call of the batch and the transform call, that is between the Init and processing. The stored parameters are used by the transform function for every image of the batch.
The flavor with the _T suffix takes a specification structure of the Threading Layer, sized and initialized by the _LT functions of the batch.
Return Values
ippStsNoErr |
Indicates no error. |
ippStsNullPtrErr |
Indicates an error when pSpec is NULL. |
ippStsContextMatchErr |
Indicates an error when pSpec was not initialized by the Init function of the same flavor of the batch. |
ippStsNoOperation |
Indicates a warning when the interpolation method of pSpec is not IPPI_INTER_CUBIC. The specification structure is left unchanged. |
See Also
Using Intel IPP Batch Resize Functions
Using Intel IPP Batch Warp Functions
ResizeBatchInit_L Initializes the specification structure of a resize batch.
ResizeBatch_L Resizes a batch of images of different sizes with a single call.
WarpBatchInit_L Initializes the specification structure of a batch warp with the default parameters of the cubic filter.