LineConvolverFactory (ImgLib2 Javadocs 0-SNAPSHOT API)

All Known Implementing Classes:

FastGaussConvolverRealType, KernelConvolverFactory
```
public interface LineConvolverFactory<T>
```
The interesting part of a separable convolution is how one line of the image is convolved. An implementation of LineConvolverFactory needs to do exactly this: Convolve one line of the image.
All the "boring" stuff is done by LineConvolution, which takes care of applying LineConvolverFactory in a multi threaded fashion on an complete image.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getBorderAfter()` When doing a convolution, a neighborhood of a pixel needs to be known.
`long`	`getBorderBefore()` When doing a convolution, a neighborhood of a pixel needs to be known.
`Runnable`	`getConvolver(RandomAccess<? extends T> in, RandomAccess<? extends T> out, int d, long lineLength)` The `Runnable` returned by this method is responsible for convolving on line of the image.
`T`	`preferredSourceType(T targetType)`

- Method Detail
  - getBorderBefore
```
long getBorderBefore()
```
    When doing a convolution, a neighborhood of a pixel needs to be known. For line convolution, neighborhood means pixels before and after.
    
    Returns:
    
    How many pixels are needed before.
  - getBorderAfter
```
long getBorderAfter()
```
    When doing a convolution, a neighborhood of a pixel needs to be known. For line convolution, neighborhood means pixels before and after.
    
    Returns:
    
    How many pixels are needed after.
  - getConvolver
```
Runnable getConvolver(RandomAccess<? extends T> in,
                      RandomAccess<? extends T> out,
                      int d,
                      long lineLength)
```
    The Runnable returned by this method is responsible for convolving on line of the image. But it will be reused. After the first line is convolved. The RandomAccesses are moved to the start of the next line. And the Runnable is executed again. LineConvolution works with multiple threads. getConvolver(net.imglib2.RandomAccess<? extends T>, net.imglib2.RandomAccess<? extends T>, int, long) is called once per thread, and the returned Runnable is exclusively used in one thread.
    
    Parameters:
    
    in - RandomAccess, that is positioned on the start of the line of the input image.
    
    out - RandomAccess, that is positioned on the start of the line of the output image.
    
    d - Dimension in which the line should go.
    
    lineLength - Length of the output line in pixels.
    
    Returns:
    
    A Runnable that will read a line of the input image, convolve it, and write the result to the output image. (Input line length should be getBorderBefore() + lineLength + getBorderAfter())
  - preferredSourceType
```
T preferredSourceType(T targetType)
```

Interface LineConvolverFactory<T>

Method Summary

Method Detail

getBorderBefore

getBorderAfter

getConvolver

preferredSourceType