MaxProjection (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.algorithm.projection.MaxProjection<T>

Type Parameters:

T -

All Implemented Interfaces:

Algorithm, Benchmark, MultiThreaded, OutputAlgorithm<T>
```
public class MaxProjection<T extends Comparable<T> & Type<T>>
extends Object
implements OutputAlgorithm<T>, Benchmark, MultiThreaded
```
Computes a maximum projection along an arbitrary dimension, if the image in 1-dimensional it will return an Image of size 1 with the max value

Author:

Stephan Preibisch (stephan.preibisch@gmx.de)

Constructor Summary

Constructors
Constructor and Description

MaxProjection(Image<T> image, int dim)

Constructors
Constructor and Description
`MaxProjection(Image<T> image, int dim)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`String`	`getErrorMessage()`
`int`	`getNumThreads()` The number of threads used by the algorithm
`long`	`getProcessingTime()`
`Image<T>`	`getResult()`
`boolean`	`process()` Get projection along the smallest dimension (which is usually the rotation axis)
`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
  - MaxProjection
```
public MaxProjection(Image<T> image,
                     int dim)
```
- Method Detail
  - process
```
public boolean process()
```
    Get projection along the smallest dimension (which is usually the rotation axis)
    
    Specified by:
    
    process in interface Algorithm
    
    Returns:
    
    - the averaged, projected PSF
  - checkInput
```
public boolean checkInput()
```
    Specified by:
    
    checkInput 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
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface Algorithm
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark
  - getResult
```
public Image<T> getResult()
```
    Specified by:
    
    getResult in interface OutputAlgorithm<T extends Comparable<T> & Type<T>>

Class MaxProjection<T extends Comparable<T> & Type<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MaxProjection

Method Detail

process

checkInput

setNumThreads

setNumThreads

getNumThreads

getErrorMessage

getProcessingTime

getResult