DefaultCostMatrixCreator (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.tracking.sparselap.costmatrix.DefaultCostMatrixCreator<K,J>

Type Parameters:

K -

All Implemented Interfaces:

CostMatrixCreator<K,J>, Algorithm, Benchmark, OutputAlgorithm<SparseCostMatrix>
```
public class DefaultCostMatrixCreator<K extends Comparable<K>,J extends Comparable<J>>
extends Object
implements CostMatrixCreator<K,J>
```
A CostMatrixCreator that build a cost matrix from 3 lists containing the sources, the targets and the associated costs.

Author:

Jean-Yves Tinevez - 2014

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultCostMatrixCreator.Assignment

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultCostMatrixCreator.Assignment`

Constructor Summary

Constructors
Constructor and Description
`DefaultCostMatrixCreator(List<K> rows, List<J> cols, double[] costs, double alternativeCostFactor, double percentile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`protected double`	`computeAlternativeCosts()`
`double`	`getAlternativeCostForSource(K source)` Returns the value of the no-linking alternative cost for the specified source.
`double`	`getAlternativeCostForTarget(J target)` Returns the value of the no-linking alternative cost for the specified target.
`String`	`getErrorMessage()`
`long`	`getProcessingTime()`
`SparseCostMatrix`	`getResult()`
`List<K>`	`getSourceList()` Returns the list of sources in the generated cost matrix.
`List<J>`	`getTargetList()` Returns the list of targets in the generated cost matrix.
`boolean`	`process()`

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

- Constructor Detail
  - DefaultCostMatrixCreator
```
public DefaultCostMatrixCreator(List<K> rows,
                                List<J> cols,
                                double[] costs,
                                double alternativeCostFactor,
                                double percentile)
```
- Method Detail
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark
  - getResult
```
public SparseCostMatrix getResult()
```
    Specified by:
    
    getResult in interface OutputAlgorithm<SparseCostMatrix>
  - checkInput
```
public boolean checkInput()
```
    Specified by:
    
    checkInput in interface Algorithm
  - process
```
public boolean process()
```
    Specified by:
    
    process in interface Algorithm
  - computeAlternativeCosts
```
protected double computeAlternativeCosts()
```
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface Algorithm
  - getSourceList
```
public List<K> getSourceList()
```
    Description copied from interface: CostMatrixCreator
    
    Returns the list of sources in the generated cost matrix.
    
    Specified by:
    
    getSourceList in interface CostMatrixCreator<K extends Comparable<K>,J extends Comparable<J>>
    
    Returns:
    
    the list of object, such that sourceList.get( i ) is the source corresponding to the row i in the generated cost matrix.
    
    See Also:
    
    CostMatrixCreator.getTargetList(), OutputAlgorithm.getResult()
  - getTargetList
```
public List<J> getTargetList()
```
    Description copied from interface: CostMatrixCreator
    
    Returns the list of targets in the generated cost matrix.
    
    Specified by:
    
    getTargetList in interface CostMatrixCreator<K extends Comparable<K>,J extends Comparable<J>>
    
    Returns:
    
    the list of objects, such that targetList.get( j ) is the target corresponding to the column j in the generated cost matrix.
    
    See Also:
    
    CostMatrixCreator.getSourceList(), OutputAlgorithm.getResult()
  - getAlternativeCostForSource
```
public double getAlternativeCostForSource(K source)
```
    Description copied from interface: CostMatrixCreator
    
    Returns the value of the no-linking alternative cost for the specified source.
    
    Specified by:
    
    getAlternativeCostForSource in interface CostMatrixCreator<K extends Comparable<K>,J extends Comparable<J>>
    
    Parameters:
    
    source - the source object.
    
    Returns:
    
    the alternative cost. Belongs to the list returned by CostMatrixCreator.getSourceList().
  - getAlternativeCostForTarget
```
public double getAlternativeCostForTarget(J target)
```
    Description copied from interface: CostMatrixCreator
    
    Returns the value of the no-linking alternative cost for the specified target.
    
    Specified by:
    
    getAlternativeCostForTarget in interface CostMatrixCreator<K extends Comparable<K>,J extends Comparable<J>>
    
    Parameters:
    
    target - the target object. Belongs to the list returned by CostMatrixCreator.getTargetList().
    
    Returns:
    
    the alternative cost.

Class DefaultCostMatrixCreator<K extends Comparable<K>,J extends Comparable<J>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultCostMatrixCreator

Method Detail

getProcessingTime

getResult

checkInput

process

computeAlternativeCosts

getErrorMessage

getSourceList

getTargetList

getAlternativeCostForSource

getAlternativeCostForTarget