CrossCorrelation (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.algorithm.correlation.CrossCorrelation<S,T>

All Implemented Interfaces:: Algorithm, MultiThreaded

public class CrossCorrelation<S extends RealType<S>,T extends RealType<T>>
extends Object
implements Algorithm, MultiThreaded

TODO

Constructor Summary

Constructors
Constructor and Description

CrossCorrelation(Image<S> image1, Image<T> image2)

Constructors
Constructor and Description
`CrossCorrelation(Image<S> image1, Image<T> image2)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`protected double`	`computeAdvancedSum(double avg1, double avg2)`
`protected <R extends RealType<R>> double`	`computeAvg(Image<R> image)`
`protected double`	`computeSimple(double avg1, double avg2)`
`static <S extends RealType<S>,T extends RealType<T>> double`	`correlate(Image<S> img1, Image<T> img2)`
`String`	`getErrorMessage()`
`int`	`getNumThreads()` The number of threads used by the algorithm
`double`	`getR()`
`boolean`	`process()`
`void`	`setNumThreads()` Sets the number of threads to the amount of processors available
`void`	`setNumThreads(int numThreads)` 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

CrossCorrelation

public CrossCorrelation(Image<S> image1,
                        Image<T> image2)

Method Detail
- correlate
```
public static <S extends RealType<S>,T extends RealType<T>> double correlate(Image<S> img1,
                                                                             Image<T> img2)
```
- getR
```
public double getR()
```
- checkInput
```
public boolean checkInput()
```
  Specified by:
  
  checkInput in interface Algorithm
- process
```
public boolean process()
```
  Specified by:
  
  process in interface Algorithm
- computeAvg
```
protected <R extends RealType<R>> double computeAvg(Image<R> image)
```
- computeSimple
```
protected double computeSimple(double avg1,
                               double avg2)
```
- computeAdvancedSum
```
protected double computeAdvancedSum(double avg1,
                                    double avg2)
```
- getErrorMessage
```
public String getErrorMessage()
```
  Specified by:
  
  getErrorMessage in interface Algorithm
- setNumThreads
```
public void setNumThreads()
```
  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)
```
  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()
```
  Description copied from interface: MultiThreaded
  
  The number of threads used by the algorithm
  
  Specified by:
  
  getNumThreads in interface MultiThreaded
  
  Returns:
  
  - the number of threads

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CrossCorrelation

Method Detail

correlate

getR

checkInput

process

computeAvg

computeSimple

computeAdvancedSum

getErrorMessage

setNumThreads

setNumThreads

getNumThreads