KalmanTracker (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.tracking.kalman.KalmanTracker

All Implemented Interfaces:

SpotTracker, Algorithm, Benchmark, MultiThreaded, OutputAlgorithm<org.jgrapht.graph.SimpleWeightedGraph<Spot,org.jgrapht.graph.DefaultWeightedEdge>>, Cancelable
```
public class KalmanTracker
extends Object
implements SpotTracker, Benchmark, Cancelable
```

Constructor Summary

Constructors
Constructor and Description

KalmanTracker(SpotCollection spots, double maxSearchRadius, int maxFrameGap, double initialSearchRadius)

Constructors
Constructor and Description
`KalmanTracker(SpotCollection spots, double maxSearchRadius, int maxFrameGap, double initialSearchRadius)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel(String reason)`
`boolean`	`checkInput()`
`String`	`getCancelReason()`
`String`	`getErrorMessage()`
`int`	`getNumThreads()`
`SpotCollection`	`getPredictions()` Returns the saved predicted state as a `SpotCollection`.
`long`	`getProcessingTime()`
`org.jgrapht.graph.SimpleWeightedGraph<Spot,org.jgrapht.graph.DefaultWeightedEdge>`	`getResult()`
`boolean`	`isCanceled()`
`boolean`	`process()`
`void`	`setLogger(Logger logger)` Sets the `Logger` instance that will receive messages from this `SpotTracker`.
`void`	`setNumThreads()`
`void`	`setNumThreads(int numThreads)`
`void`	`setSavePredictions(boolean doSave)` Sets whether the tracker saves the predicted states.

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

- Constructor Detail
  - KalmanTracker
```
public KalmanTracker(SpotCollection spots,
                     double maxSearchRadius,
                     int maxFrameGap,
                     double initialSearchRadius)
```
    Parameters:
    
    spots - the spots to track.
    
    maxSearchRadius -
    
    maxFrameGap -
    
    initialSearchRadius -
- Method Detail
  - getResult
```
public org.jgrapht.graph.SimpleWeightedGraph<Spot,org.jgrapht.graph.DefaultWeightedEdge> getResult()
```
    Specified by:
    
    getResult in interface OutputAlgorithm<org.jgrapht.graph.SimpleWeightedGraph<Spot,org.jgrapht.graph.DefaultWeightedEdge>>
  - checkInput
```
public boolean checkInput()
```
    Specified by:
    
    checkInput in interface Algorithm
  - process
```
public boolean process()
```
    Specified by:
    
    process in interface Algorithm
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface Algorithm
  - getPredictions
```
public SpotCollection getPredictions()
```
    Returns the saved predicted state as a SpotCollection.
    
    Returns:
    
    the predicted states.
    
    See Also:
    
    setSavePredictions(boolean)
  - setSavePredictions
```
public void setSavePredictions(boolean doSave)
```
    Sets whether the tracker saves the predicted states.
    
    Parameters:
    
    doSave - if true, the predicted states will be saved.
    
    See Also:
    
    getPredictions()
  - setNumThreads
```
public void setNumThreads()
```
    Specified by:
    
    setNumThreads in interface MultiThreaded
  - setNumThreads
```
public void setNumThreads(int numThreads)
```
    Specified by:
    
    setNumThreads in interface MultiThreaded
  - getNumThreads
```
public int getNumThreads()
```
    Specified by:
    
    getNumThreads in interface MultiThreaded
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark
  - setLogger
```
public void setLogger(Logger logger)
```
    Description copied from interface: SpotTracker
    
    Sets the Logger instance that will receive messages from this SpotTracker.
    
    Specified by:
    
    setLogger in interface SpotTracker
    
    Parameters:
    
    logger - the logger to echo messages to.
  - isCanceled
```
public boolean isCanceled()
```
    Specified by:
    
    isCanceled in interface Cancelable
  - cancel
```
public void cancel(String reason)
```
    Specified by:
    
    cancel in interface Cancelable
  - getCancelReason
```
public String getCancelReason()
```
    Specified by:
    
    getCancelReason in interface Cancelable

Class KalmanTracker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KalmanTracker

Method Detail

getResult

checkInput

process

getErrorMessage

getPredictions

setSavePredictions

setNumThreads

setNumThreads

getNumThreads

getProcessingTime

setLogger

isCanceled

cancel

getCancelReason