ManualEdgeColorAnalyzer (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.features.manual.ManualEdgeColorAnalyzer

All Implemented Interfaces:

EdgeAnalyzer, FeatureAnalyzer, TrackMateModule, Benchmark, MultiThreaded, SciJavaPlugin
```
public class ManualEdgeColorAnalyzer
extends Object
implements EdgeAnalyzer
```

Field Summary

Fields
Modifier and Type Field and Description

static String FEATURE

static String KEY

Fields
Modifier and Type	Field and Description
`static String`	`FEATURE`
`static String`	`KEY`

Constructor Summary

Constructors
Constructor and Description

ManualEdgeColorAnalyzer()

Constructors
Constructor and Description
`ManualEdgeColorAnalyzer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Dimension>`	`getFeatureDimensions()` Returns the map of feature dimension this analyzer can compute.
`Map<String,String>`	`getFeatureNames()` Returns the map of names for any feature this analyzer can compute.
`List<String>`	`getFeatures()` Returns the list of features this analyzer can compute.
`Map<String,String>`	`getFeatureShortNames()` Returns the map of short names for any feature the analyzer can compute.
`ImageIcon`	`getIcon()` Returns the icon for this action.
`String`	`getInfoText()` Returns a html string containing a descriptive information about this module.
`Map<String,Boolean>`	`getIsIntFeature()` Returns the map that states whether the key feature is a feature that returns integers.
`String`	`getKey()` Returns a unique identifier of this module.
`String`	`getName()` Returns the human-compliant name of this module.
`int`	`getNumThreads()`
`long`	`getProcessingTime()`
`boolean`	`isLocal()` Returns `true` if this analyzer is a local analyzer.
`boolean`	`isManualFeature()` Returns whether all the features declared in this `FeatureAnalyzer` are manual features.
`void`	`process(Collection<org.jgrapht.graph.DefaultWeightedEdge> edges, Model model)` Scores a collection of link between two spots.
`void`	`setNumThreads()`
`void`	`setNumThreads(int numThreads)`

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

Methods inherited from interface fiji.plugin.trackmate.TrackMateModule
forbidMultithreading

- Field Detail
  - FEATURE
```
public static final String FEATURE
```
    See Also:
    
    Constant Field Values
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ManualEdgeColorAnalyzer
```
public ManualEdgeColorAnalyzer()
```
- Method Detail
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark
  - getKey
```
public String getKey()
```
    Description copied from interface: TrackMateModule
    
    Returns a unique identifier of this module.
    
    Specified by:
    
    getKey in interface TrackMateModule
    
    Returns:
    
    the action key, as a string.
  - getFeatures
```
public List<String> getFeatures()
```
    Description copied from interface: FeatureAnalyzer
    
    Returns the list of features this analyzer can compute.
    
    Specified by:
    
    getFeatures in interface FeatureAnalyzer
  - getFeatureShortNames
```
public Map<String,String> getFeatureShortNames()
```
    Description copied from interface: FeatureAnalyzer
    
    Returns the map of short names for any feature the analyzer can compute.
    
    Specified by:
    
    getFeatureShortNames in interface FeatureAnalyzer
  - getFeatureNames
```
public Map<String,String> getFeatureNames()
```
    Description copied from interface: FeatureAnalyzer
    
    Returns the map of names for any feature this analyzer can compute.
    
    Specified by:
    
    getFeatureNames in interface FeatureAnalyzer
  - getFeatureDimensions
```
public Map<String,Dimension> getFeatureDimensions()
```
    Description copied from interface: FeatureAnalyzer
    
    Returns the map of feature dimension this analyzer can compute.
    
    Specified by:
    
    getFeatureDimensions in interface FeatureAnalyzer
  - getIsIntFeature
```
public Map<String,Boolean> getIsIntFeature()
```
    Description copied from interface: FeatureAnalyzer
    
    Returns the map that states whether the key feature is a feature that returns integers. If true, then special treatment is applied when saving/loading, etc. for clarity and precision.
    
    Specified by:
    
    getIsIntFeature in interface FeatureAnalyzer
  - 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
  - getInfoText
```
public String getInfoText()
```
    Description copied from interface: TrackMateModule
    
    Returns a html string containing a descriptive information about this module.
    
    Specified by:
    
    getInfoText in interface TrackMateModule
    
    Returns:
    
    a html string.
  - getIcon
```
public ImageIcon getIcon()
```
    Description copied from interface: TrackMateModule
    
    Returns the icon for this action. Can be null.
    
    Specified by:
    
    getIcon in interface TrackMateModule
    
    Returns:
    
    the icon. Returns null to be safely ignored.
  - getName
```
public String getName()
```
    Description copied from interface: TrackMateModule
    
    Returns the human-compliant name of this module.
    
    Specified by:
    
    getName in interface TrackMateModule
    
    Returns:
    
    the name, as a String.
  - process
```
public void process(Collection<org.jgrapht.graph.DefaultWeightedEdge> edges,
                    Model model)
```
    Description copied from interface: EdgeAnalyzer
    
    Scores a collection of link between two spots. The results must be stored in the FeatureModel.
    Note: ideally concrete implementation should work in a multi-threaded fashion for performance reason, when possible.
    
    Specified by:
    
    process in interface EdgeAnalyzer
    
    Parameters:
    
    edges - the collection of edges whose features are to be calculated.
    
    model - the Model they belong to.
  - isLocal
```
public boolean isLocal()
```
    Description copied from interface: EdgeAnalyzer
    
    Returns true if this analyzer is a local analyzer. That is: a modification that affects only one edge requires the edge features to be re-calculated only for this edge. If false, any model modification involving an edge will trigger a recalculation over the whole track this edge belong to.
    Example of local edge feature: the edge length (distance between the two spots). This one does not depend on other edge values.
    Example of non-local edge feature: the local curvature of the trajectory, which depends on the neighbor edges.
    
    Specified by:
    
    isLocal in interface EdgeAnalyzer
  - isManualFeature
```
public boolean isManualFeature()
```
    Description copied from interface: FeatureAnalyzer
    
    Returns whether all the features declared in this FeatureAnalyzer are manual features.
    Manual features are not calculated normally using an analyzer, nor cleared at each recalculation. Another classes are responsible to set their value. The concrete FeatureAnalyzer calculation method is not called by TrackMate when a change happens to the model. Therefore the calculation routine of the FeatureAnalyzer can be used to discard the manually stored value of these features.
    
    Specified by:
    
    isManualFeature in interface FeatureAnalyzer
    
    Returns:
    
    true if the features declared in this analyzer are manual feature.

Class ManualEdgeColorAnalyzer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface fiji.plugin.trackmate.TrackMateModule

Field Detail

FEATURE

KEY

Constructor Detail

ManualEdgeColorAnalyzer

Method Detail

getProcessingTime

getKey

getFeatures

getFeatureShortNames

getFeatureNames

getFeatureDimensions

getIsIntFeature

setNumThreads

setNumThreads

getNumThreads

getInfoText

getIcon

getName

process

isLocal

isManualFeature