ImageCalculator (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.algorithm.math.ImageCalculator<S,T,U>

All Implemented Interfaces:: Algorithm, Benchmark, MultiThreaded, OutputAlgorithm

Direct Known Subclasses:: ImageCalculatorInPlace

public class ImageCalculator<S extends Type<S>,T extends Type<T>,U extends Type<U>>
extends Object
implements OutputAlgorithm<U>, MultiThreaded, Benchmark

TODO

Author:: Stephan Preibisch

Constructor Summary

Constructors
Constructor and Description
`ImageCalculator(Image<S> image1, Image<T> image2, Image<U> output, Function<S,T,U> function)`
`ImageCalculator(Image<S> image1, Image<T> image2, ImageFactory<U> factory, Function<S,T,U> function)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`protected void`	`computeAdvanced(long startPos, long loopSize)`
`protected void`	`computeSimple(long startPos, long loopSize)`
`protected static <U extends Type<U>> Image<U>`	`createImageFromFactory(ImageFactory<U> factory, int[] size)`
`String`	`getErrorMessage()`
`int`	`getNumThreads()` The number of threads used by the algorithm
`long`	`getProcessingTime()`
`Image<U>`	`getResult()`
`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

ImageCalculator

public ImageCalculator(Image<S> image1,
                       Image<T> image2,
                       Image<U> output,
                       Function<S,T,U> function)

ImageCalculator

public ImageCalculator(Image<S> image1,
                       Image<T> image2,
                       ImageFactory<U> factory,
                       Function<S,T,U> function)

Method Detail
- getResult
```
public Image getResult()
```
 Specified by:
 
 getResult in interface OutputAlgorithm>
- checkInput
```
public boolean checkInput()
```
 Specified by:
 
 checkInput in interface Algorithm
- process
```
public boolean process()
```
 Specified by:
 
 process in interface Algorithm
- computeSimple
```
protected void computeSimple(long startPos,
 long loopSize)
```
- computeAdvanced
```
protected void computeAdvanced(long startPos,
 long loopSize)
```
- 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
- getErrorMessage
```
public String getErrorMessage()
```
 Specified by:
 
 getErrorMessage in interface Algorithm
- getProcessingTime
```
public long getProcessingTime()
```
 Specified by:
 
 getProcessingTime in interface Benchmark
- createImageFromFactory
```
protected static > Image createImageFromFactory(ImageFactory factory,
 int[] size)
```

Class ImageCalculator<S extends Type<S>,T extends Type<T>,U extends Type<U>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageCalculator

ImageCalculator

Method Detail

getResult

checkInput

process

computeSimple

computeAdvanced

setNumThreads

setNumThreads

getNumThreads

getErrorMessage

getProcessingTime

createImageFromFactory