TrackIndexAnalyzer (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.features.track.TrackIndexAnalyzer

All Implemented Interfaces:

FeatureAnalyzer, TrackAnalyzer, TrackMateModule, Benchmark, MultiThreaded, SciJavaPlugin
```
public class TrackIndexAnalyzer
extends Object
implements TrackAnalyzer
```

Field Summary

Fields
Modifier and Type	Field and Description
`static Map<String,Dimension>`	`FEATURE_DIMENSIONS`
`static Map<String,String>`	`FEATURE_NAMES`
`static Map<String,String>`	`FEATURE_SHORT_NAMES`
`static List<String>`	`FEATURES`
`static Map<String,Boolean>`	`IS_INT`
`static String`	`KEY` The key for this analyzer.
`static String`	`TRACK_ID`
`static String`	`TRACK_INDEX` The key for the feature TRACK_INDEX

Constructor Summary

Constructors
Constructor and Description

TrackIndexAnalyzer()

Constructors
Constructor and Description
`TrackIndexAnalyzer()`

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()` Ignore.
`long`	`getProcessingTime()`
`boolean`	`isLocal()` `TrackIndexAnalyzer` is not local, since the indices are re-arranged according to names.
`boolean`	`isManualFeature()` Returns whether all the features declared in this `FeatureAnalyzer` are manual features.
`void`	`process(Collection<Integer> trackIDs, Model model)` Compute the features of the track whose ID is given.
`void`	`setNumThreads()` Ignored.
`void`	`setNumThreads(int numThreads)` Ignored.

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
  - KEY
```
public static final String KEY
```
    The key for this analyzer.
    
    See Also:
    
    Constant Field Values
  - TRACK_INDEX
```
public static final String TRACK_INDEX
```
    The key for the feature TRACK_INDEX
    
    See Also:
    
    Constant Field Values
  - TRACK_ID
```
public static final String TRACK_ID
```
    See Also:
    
    Constant Field Values
  - FEATURES
```
public static final List<String> FEATURES
```
  - FEATURE_NAMES
```
public static final Map<String,String> FEATURE_NAMES
```
  - FEATURE_SHORT_NAMES
```
public static final Map<String,String> FEATURE_SHORT_NAMES
```
  - FEATURE_DIMENSIONS
```
public static final Map<String,Dimension> FEATURE_DIMENSIONS
```
  - IS_INT
```
public static final Map<String,Boolean> IS_INT
```
- Constructor Detail
  - TrackIndexAnalyzer
```
public TrackIndexAnalyzer()
```
- Method Detail
  - isLocal
```
public boolean isLocal()
```
    TrackIndexAnalyzer is not local, since the indices are re-arranged according to names.
    
    Specified by:
    
    isLocal in interface TrackAnalyzer
  - process
```
public void process(Collection<Integer> trackIDs,
                    Model model)
```
    Description copied from interface: TrackAnalyzer
    
    Compute the features of the track whose ID is given.
    
    Specified by:
    
    process in interface TrackAnalyzer
    
    Parameters:
    
    trackIDs - the IDs of the track whose features are to be calculated.
    
    model - the Model from which actual tracks are to be retrieved.
  - 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
  - setNumThreads
```
public void setNumThreads()
```
    Ignored. This analyzer is single-threaded.
    
    Specified by:
    
    setNumThreads in interface MultiThreaded
  - setNumThreads
```
public void setNumThreads(int numThreads)
```
    Ignored. This analyzer is single-threaded.
    
    Specified by:
    
    setNumThreads in interface MultiThreaded
  - getNumThreads
```
public int getNumThreads()
```
    Ignore. This analyzer is single-threaded.
    
    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.
  - 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
  - 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 TrackIndexAnalyzer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface fiji.plugin.trackmate.TrackMateModule

Field Detail

KEY

TRACK_INDEX

TRACK_ID

FEATURES

FEATURE_NAMES

FEATURE_SHORT_NAMES

FEATURE_DIMENSIONS

IS_INT

Constructor Detail

TrackIndexAnalyzer

Method Detail

isLocal

process

getProcessingTime

getKey

getFeatures

getFeatureShortNames

getFeatureNames

getFeatureDimensions

setNumThreads

setNumThreads

getNumThreads

getInfoText

getIcon

getName

getIsIntFeature

isManualFeature