DownSample (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.algorithm.gauss.DownSample<T>

All Implemented Interfaces:: Algorithm, Benchmark, MultiThreaded, OutputAlgorithm<T>

public class DownSample<T extends RealType<T>>
extends Object
implements MultiThreaded, OutputAlgorithm<T>, Benchmark

TODO

Author:: Stephan Saalfeld, Stephan Preibisch

Constructor Summary

Constructors
Constructor and Description
`DownSample(Image<T> image, float downSamplingFactor)`
`DownSample(Image<T> image, int[] newSize, float sourceSigma, float targetSigma)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`String`	`getErrorMessage()`
`Image<T>`	`getInputImage()`
`int[]`	`getNewSize()`
`int`	`getNumThreads()` The number of threads used by the algorithm
`long`	`getProcessingTime()`
`Image<T>`	`getResult()`
`float`	`getSourceSigma()`
`float`	`getTargetSigma()`
`boolean`	`process()`
`void`	`setDownSamplingFactor(float factor)`
`void`	`setInputImage(Image<T> image)`
`void`	`setNewSize(int[] newSize)`
`void`	`setNumThreads()` Sets the number of threads to the amount of processors available
`void`	`setNumThreads(int numThreads)` Sets the number of threads
`void`	`setSourceSigma(float sourceSigma)`
`void`	`setTargetSigma(float targetSigma)`

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

- Constructor Detail
  - DownSample
```
public DownSample(Image<T> image,
                  int[] newSize,
                  float sourceSigma,
                  float targetSigma)
```
  - DownSample
```
public DownSample(Image<T> image,
                  float downSamplingFactor)
```
- Method Detail
  - setSourceSigma
```
public void setSourceSigma(float sourceSigma)
```
  - setTargetSigma
```
public void setTargetSigma(float targetSigma)
```
  - setDownSamplingFactor
```
public void setDownSamplingFactor(float factor)
```
  - setNewSize
```
public void setNewSize(int[] newSize)
```
  - setInputImage
```
public void setInputImage(Image<T> image)
```
  - getSourceSigma
```
public float getSourceSigma()
```
  - getTargetSigma
```
public float getTargetSigma()
```
  - getNewSize
```
public int[] getNewSize()
```
  - getInputImage
```
public Image<T> getInputImage()
```
  - process
```
public boolean process()
```
    Specified by:
    
    process in interface Algorithm
  - checkInput
```
public boolean checkInput()
```
    Specified by:
    
    checkInput in interface Algorithm
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface Algorithm
  - getResult
```
public Image<T> getResult()
```
    Specified by:
    
    getResult in interface OutputAlgorithm<T extends RealType<T>>
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark
  - 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
  - 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

Class DownSample<T extends RealType<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DownSample

DownSample

Method Detail

setSourceSigma

setTargetSigma

setDownSamplingFactor

setNewSize

setInputImage

getSourceSigma

getTargetSigma

getNewSize

getInputImage

process

checkInput

getErrorMessage

getResult

getProcessingTime

getNumThreads

setNumThreads

setNumThreads