Kernel Argument Object Factories

These factory functions allow to create argument objects for 1D and 2D convolution kernel analogously to Argument Object Factories for images.

kernel1d()

Pass a \ref vigra::Kernel1D to a 1D or separable convolution algorithm.

These factories can be used to create argument objects when we
are given instances or subclasses of \ref vigra::Kernel1D
(analogous to the \ref ArgumentObjectFactories for images).
These factory functions access <TT>kernel.center()</TT>,
<TT>kernel.left()</TT>, <TT>kernel.right()</TT>, <TT>kernel.accessor()</TT>,
and  <TT>kernel.borderTreatment()</TT> to obtain the necessary
information. The following factory functions are provided:

<table>
<tr><th bgcolor="#f0e0c0" colspan=2 align=left>
    <TT>\ref vigra::Kernel1D "vigra::Kernel1D<SomeType>" kernel;</TT>
    </th>
</tr>
<tr><td>
<TT>kernel1d(kernel)</TT>
</td><td>
    create argument object from information provided by
    kernel

</td></tr>
<tr><td>
<TT>kernel1d(kernel, vigra::BORDER_TREATMENT_CLIP)</TT>
</td><td>
    create argument object from information provided by
    kernel, but use given border treatment mode

</td></tr>
<tr><td>
<TT>kernel1d(kerneliterator, kernelaccessor,</TT><br>
<TT>                kernelleft, kernelright,</TT><br>
<TT>                vigra::BORDER_TREATMENT_CLIP)</TT>
</td><td>
    create argument object from explicitly given iterator
    (pointing to the center of th kernel), accessor,
    left and right boundaries, and border treatment mode

</table>

For usage examples see \ref convolveImage().

kernel2d()

Pass a \ref vigra::Kernel2D to a 2D (non-separable) convolution algorithm.

These factories can be used to create argument objects when we
are given instances or subclasses of \ref vigra::Kernel2D
(analogous to the \ref ArgumentObjectFactories for images).
These factory functions access <TT>kernel.center()</TT>,
<TT>kernel.upperLeft()</TT>, <TT>kernel.lowerRight()</TT>, <TT>kernel.accessor()</TT>,
and  <TT>kernel.borderTreatment()</TT> to obtain the necessary
information. The following factory functions are provided:

<table>
<tr><th bgcolor="#f0e0c0" colspan=2 align=left>
    <TT>\ref vigra::Kernel2D "vigra::Kernel2D<SomeType>" kernel;</TT>
    </th>
</tr>
<tr><td>
<TT>kernel2d(kernel)</TT>
</td><td>
    create argument object from information provided by
    kernel

</td></tr>
<tr><td>
<TT>kernel2d(kernel, vigra::BORDER_TREATMENT_CLIP)</TT>
</td><td>
    create argument object from information provided by
    kernel, but use given border treatment mode

</td></tr>
<tr><td>
<TT>kernel2d(kerneliterator, kernelaccessor,</TT>
<TT>                upperleft, lowerright,</TT>
<TT>                vigra::BORDER_TREATMENT_CLIP)</TT>
</td><td>
    create argument object from explicitly given iterator
    (pointing to the center of th kernel), accessor,
    upper left and lower right corners, and border treatment mode

</table>

For usage examples see \ref convolveImage().