FourierConvolution (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.algorithm.fft.FourierConvolution<T,S>

Type Parameters:

T - - RealType of the image

S - - RealType of the kernel

All Implemented Interfaces:

Algorithm, Benchmark, MultiThreaded, OutputAlgorithm<Img<T>>

Direct Known Subclasses:

InverseFourierConvolution

Deprecated.
use FFTConvolution instead
```
@Deprecated
public class FourierConvolution<T extends RealType<T>,S extends RealType<S>>
extends Object
implements MultiThreaded, OutputAlgorithm<Img<T>>, Benchmark
```
Computes a convolution of an Img or RandomAccessibleInterval with an kernel. The computation is based on the Fourier convolution theorem and computation time is therefore independent of the size of kernel (except the kernel becomes bigger than the input, which makes limited sense). It is possible to exchange the kernel or the image if a series of images is convolved with the same kernel - or if an image has to be convolved with multiple kernels. The precision of the computation is ComplexFloatType.

Author:

Stephan Preibisch

Constructor Summary

Constructors
Constructor and Description
`FourierConvolution(Img<T> image, Img<S> kernel)` Deprecated. Computes a convolution in Fourier space.
`FourierConvolution(Img<T> image, Img<S> kernel, ImgFactory<ComplexFloatType> fftImgFactory)` Deprecated. Computes a convolution in Fourier space.
`FourierConvolution(RandomAccessibleInterval<T> image, RandomAccessibleInterval<S> kernel, ImgFactory<T> imgFactory, ImgFactory<S> kernelImgFactory, ImgFactory<ComplexFloatType> fftImgFactory)` Deprecated. Computes a convolution in Fourier space.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()` Deprecated.
`static <T extends RealType<T>,S extends RealType<S>> Img<T>`	`convolve(Img<T> img, Img<S> kernel)` Deprecated.
`static <T extends RealType<T>,S extends RealType<S>> Img<T>`	`convolve(RandomAccessibleInterval<T> input, RandomAccessibleInterval<S> kernel, ImgFactory<T> imgFactory, ImgFactory<S> kernelImgFactory, ImgFactory<ComplexFloatType> fftImgFactory)` Deprecated.
`static Img<FloatType>`	`createGaussianKernel(ImgFactory<FloatType> factory, double[] sigmas)` Deprecated.
`static Img<FloatType>`	`createGaussianKernel(ImgFactory<FloatType> factory, double sigma, int numDimensions)` Deprecated.
`ImgFactory<ComplexFloatType>`	`fftImgFactory()` Deprecated.
`String`	`getErrorMessage()` Deprecated.
`boolean`	`getKeepImgFFT()` Deprecated.
`int`	`getNumThreads()` Deprecated. The number of threads used by the algorithm
`long`	`getProcessingTime()` Deprecated.
`Img<T>`	`getResult()` Deprecated.
`ImgFactory<T>`	`imgFactory()` Deprecated.
`protected void`	`multiply(RandomAccessibleInterval<ComplexFloatType> a, RandomAccessibleInterval<ComplexFloatType> b)` Deprecated. Multiply in Fourier Space
`boolean`	`process()` Deprecated.
`boolean`	`replaceInput(RandomAccessibleInterval<T> img)` Deprecated.
`boolean`	`replaceKernel(RandomAccessibleInterval<S> knl)` Deprecated.
`void`	`setKeepImgFFT(boolean keepImgFFT)` Deprecated. By default, he will not do the computation in-place and keep the imgFFT
`void`	`setNumThreads()` Deprecated. Sets the number of threads to the amount of processors available
`void`	`setNumThreads(int numThreads)` Deprecated. Sets the number of threads

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- FourierConvolution
```
public FourierConvolution(RandomAccessibleInterval<T> image,
                          RandomAccessibleInterval<S> kernel,
                          ImgFactory<T> imgFactory,
                          ImgFactory<S> kernelImgFactory,
                          ImgFactory<ComplexFloatType> fftImgFactory)
```
  Deprecated.
  
  Computes a convolution in Fourier space.
  
  Parameters:
  
  image - - the input to be convolved
  
  kernel - - the kernel for the convolution operation
  
  fftImgFactory - - the ImgFactory that is used to create the FFT's
  
  imgFactory - - the ImgFactory that is used to compute the convolved image
  
  kernelImgFactory - - the ImgFactory that is used to extend the kernel to the right size
- FourierConvolution
```
public FourierConvolution(Img<T> image,
                          Img<S> kernel,
                          ImgFactory<ComplexFloatType> fftImgFactory)
```
  Deprecated.
  
  Computes a convolution in Fourier space.
  
  Parameters:
  
  image - - the input Img to be convolved
  
  kernel - - the kernel Img for the convolution operation
  
  fftImgFactory - - the ImgFactory that is used to create the FFT's
- FourierConvolution
```
public FourierConvolution(Img<T> image,
                          Img<S> kernel)
                   throws IncompatibleTypeException
```
  Deprecated.
  
  Computes a convolution in Fourier space.
  
  Parameters:
  
  image - - the input Img to be convolved
  
  kernel - - the kernel Img for the convolution operation
  
  Throws:
  
  IncompatibleTypeException - if the factory of the input Img<T> is not compatible with the ComplexFloatType (it needs to be a NativeType)

Method Detail

convolve

public static <T extends RealType<T>,S extends RealType<S>> Img<T> convolve(Img<T> img,
                                                                            Img<S> kernel)
                                                                     throws IncompatibleTypeException

Deprecated.

Throws:: IncompatibleTypeException

convolve

public static <T extends RealType<T>,S extends RealType<S>> Img<T> convolve(RandomAccessibleInterval<T> input,
                                                                            RandomAccessibleInterval<S> kernel,
                                                                            ImgFactory<T> imgFactory,
                                                                            ImgFactory<S> kernelImgFactory,
                                                                            ImgFactory<ComplexFloatType> fftImgFactory)

Deprecated.

fftImgFactory
```
public ImgFactory<ComplexFloatType> fftImgFactory()
```
Deprecated.

Returns:

- the ImgFactory that is used to create the FFT's

imgFactory
```
public ImgFactory<T> imgFactory()
```
Deprecated.

Returns:

- the ImgFactory that is used to compute the convolved image

replaceInput

public boolean replaceInput(RandomAccessibleInterval<T> img)

Deprecated.

setKeepImgFFT
```
public void setKeepImgFFT(boolean keepImgFFT)
```
Deprecated.

By default, he will not do the computation in-place and keep the imgFFT

Parameters:

keepImgFFT -

getKeepImgFFT
```
public boolean getKeepImgFFT()
```
Deprecated.

replaceKernel

public boolean replaceKernel(RandomAccessibleInterval<S> knl)

Deprecated.

createGaussianKernel

public static final Img<FloatType> createGaussianKernel(ImgFactory<FloatType> factory,
                                                        double sigma,
                                                        int numDimensions)

Deprecated.

createGaussianKernel

public static final Img<FloatType> createGaussianKernel(ImgFactory<FloatType> factory,
                                                        double[] sigmas)

Deprecated.

process
```
public boolean process()
```
Deprecated.

Specified by:

process in interface Algorithm

multiply

protected void multiply(RandomAccessibleInterval<ComplexFloatType> a,
                        RandomAccessibleInterval<ComplexFloatType> b)

Deprecated.

Multiply in Fourier Space

Parameters:: a -; b -

getProcessingTime
```
public long getProcessingTime()
```
Deprecated.

Specified by:

getProcessingTime in interface Benchmark

setNumThreads
```
public void setNumThreads()
```
Deprecated.

Description copied from interface: MultiThreaded

Sets the number of threads to the amount of processors available

Specified by:

setNumThreads in interface MultiThreaded

setNumThreads
```
public void setNumThreads(int numThreads)
```
Deprecated.

Description copied from interface: MultiThreaded

Sets the number of threads

Specified by:

setNumThreads in interface MultiThreaded

Parameters:

numThreads - - number of threads to use

getNumThreads
```
public int getNumThreads()
```
Deprecated.

Description copied from interface: MultiThreaded

The number of threads used by the algorithm

Specified by:

getNumThreads in interface MultiThreaded

Returns:

- the number of threads

getResult
```
public Img<T> getResult()
```
Deprecated.

Specified by:

getResult in interface OutputAlgorithm<Img<T extends RealType<T>>>

checkInput
```
public boolean checkInput()
```
Deprecated.

Specified by:

checkInput in interface Algorithm

getErrorMessage
```
public String getErrorMessage()
```
Deprecated.

Specified by:

getErrorMessage in interface Algorithm

Class FourierConvolution<T extends RealType<T>,S extends RealType<S>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FourierConvolution

FourierConvolution

FourierConvolution

Method Detail

convolve

convolve

fftImgFactory

imgFactory

replaceInput

setKeepImgFFT

getKeepImgFFT

replaceKernel

createGaussianKernel

createGaussianKernel

process

multiply

getProcessingTime

setNumThreads

setNumThreads

getNumThreads

getResult

checkInput

getErrorMessage