TrackMateModule (Fiji Javadocs 0-SNAPSHOT API)

All Superinterfaces:

SciJavaPlugin

All Known Subinterfaces:

EdgeAnalyzer, FeatureAnalyzer, SpotAnalyzerFactory<T>, SpotAnalyzerFactoryBase<T>, SpotDetectorFactory<T>, SpotDetectorFactoryBase<T>, SpotGlobalDetectorFactory<T>, SpotMorphologyAnalyzerFactory<T>, SpotTrackerFactory, TrackAnalyzer, TrackMateActionFactory, ViewFactory

All Known Implementing Classes:

AbstractEdgeAnalyzer, AbstractTrackAnalyzer, CaptureOverlayAction.Factory, CloseGapsByLinearInterpolationAction.Factory, DirectionalChangeAnalyzer, DogDetectorFactory, EdgeSpeedAnalyzer, EdgeTargetAnalyzer, EdgeTimeLocationAnalyzer, ExportAllSpotsStatsAction.Factory, ExportStatsTablesAction.Factory, ExportTracksToXML.Factory, ExtractTrackStackAction.ExtractTrackStackActionFactory, HyperStackDisplayerFactory, IcyTrackExporter.Factory, ISBIChallengeExporter.Factory, KalmanTrackerFactory, LabeImageDetectorFactory, LabelImgExporter.Factory, LAPTrackerFactory, LogDetectorFactory, ManualDetectorFactory, ManualEdgeColorAnalyzer, ManualSpotColorAnalyzerFactory, ManualTrackerFactory, MaskDetectorFactory, MergeFileAction.Factory, NearestNeighborTrackerFactory, OverlapTrackerFactory, PlotNSpotsVsTimeAction.Factory, RecomputeFeatureAction.Factory, ResetSpotTimeFeatureAction.Factory, SimpleSparseLAPTrackerFactory, SparseLAPTrackerFactory, SpotContrastAndSNRAnalyzerFactory, SpotFitEllipseAnalyzerFactory, SpotGaussianFitter.Factory, SpotIntensityMultiCAnalyzerFactory, SpotShapeAnalyzerFactory, ThresholdDetectorFactory, TrackBranchAnalysis.Factory, TrackBranchingAnalyzer, TrackDurationAnalyzer, TrackIndexAnalyzer, TrackLocationAnalyzer, TrackMotilityAnalyzer, TrackSchemeFactory, TrackSpeedStatisticsAnalyzer, TrackSpotQualityFeatureAnalyzer, TrimNotVisibleAction.Factory
```
public interface TrackMateModule
extends SciJavaPlugin
```
Interface for TrackMate modules.
Modules are the way users can extend TrackMate. We rely on SciJava automatic plugin discovery to facilitate extension. To have a module discovered annotate its class with for instance
```
 @Plugin( type = SpotAnalyzerFactory.class, priority = Priority.LOW, visible = false )
 
```
This will have a SpotAnalyzerFactory module registered in TrackMate. It will be given a priority of 1 (0 is the default), which means that it will be run after the analyzers of a lower priority. This is used when some modules depends on the results generated by other modules. The visible tag determines whether the module is visible or not in the GUI.
Currently there are 7 types of modules:
- SpotDetectorFactory: generates detectors for the detection step of TrackMate.
- SpotAnalyzerFactory: generates analyzers that grant spots with scalar numerical features.
- ViewFactory: generates views that can display the detection and tracking results.
- SpotTrackerFactory: generates particle linkers for the tracking step of TrackMate.
- TrackAnalyzer: compute scalar numerical features for tracks.
- EdgeAnalyzer: compute scalar numerical features for edges (individual links between spots).
- TrackMateActionFactory: generates actions that provide general use actions for TrackMate from the GUI.
Author:

Jean-Yves Tinevez <jeanyves.tinevez@gmail.com> 2014

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`forbidMultithreading()` Returns a flag that tells TrackMate whether it should strictly forbid running this module concurrently.
`ImageIcon`	`getIcon()` Returns the icon for this action.
`String`	`getInfoText()` Returns a html string containing a descriptive information about this module.
`String`	`getKey()` Returns a unique identifier of this module.
`String`	`getName()` Returns the human-compliant name of this module.

- Method Detail
  - getInfoText
```
String getInfoText()
```
    Returns a html string containing a descriptive information about this module.
    
    Returns:
    
    a html string.
  - getIcon
```
ImageIcon getIcon()
```
    Returns the icon for this action. Can be null.
    
    Returns:
    
    the icon. Returns null to be safely ignored.
  - getKey
```
String getKey()
```
    Returns a unique identifier of this module.
    
    Returns:
    
    the action key, as a string.
  - getName
```
String getName()
```
    Returns the human-compliant name of this module.
    
    Returns:
    
    the name, as a String.
  - forbidMultithreading
```
default boolean forbidMultithreading()
```
    Returns a flag that tells TrackMate whether it should strictly forbid running this module concurrently.
    This might be the case for instance if you have a spot detector that you want to run strictly one frame after another, to save resources or because the multi-threading of the detector cannot be controlled. In that case this flag should be set to true.
    If false (the default), the multi-threading will be decided by TrackMate.
    
    Returns:
    
    whether to forbid running this module concurrently

Interface TrackMateModule

Method Summary

Method Detail

getInfoText

getIcon

getKey

getName

forbidMultithreading