TrackerKeys (TrackMate 7.14.0 API)

java.lang.Object
- fiji.plugin.trackmate.tracking.TrackerKeys

```
public class TrackerKeys
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_ALLOW_GAP_CLOSING` A default value for the "ALLOW_GAP_CLOSING" parameter.
`static boolean`	`DEFAULT_ALLOW_TRACK_MERGING` A default value for the "ALLOW_TRACK_MERGING" parameter.
`static boolean`	`DEFAULT_ALLOW_TRACK_SPLITTING` A default value for the "ALLOW_TRACK_SPLITTING" parameter.
`static double`	`DEFAULT_ALTERNATIVE_LINKING_COST_FACTOR` A default value for the "ALTERNATIVE_LINKING_COST_FACTOR" parameter.
`static double`	`DEFAULT_BLOCKING_VALUE` A default value for the "BLOCKING_VALUE" parameter.
`static double`	`DEFAULT_CUTOFF_PERCENTILE` A default value for the "CUTOFF_PERCENTILE" parameter.
`static Map<String,Double>`	`DEFAULT_GAP_CLOSING_FEATURE_PENALTIES` A default value for the "GAP_CLOSING_FEATURE_PENALTIES" parameter.
`static double`	`DEFAULT_GAP_CLOSING_MAX_DISTANCE` A default value for the "GAP_CLOSING_MAX_DISTANCE" parameter.
`static int`	`DEFAULT_GAP_CLOSING_MAX_FRAME_GAP` A default value for the "MAX_FRAME_GAP" parameter.
`static double`	`DEFAULT_KALMAN_SEARCH_RADIUS` A default value for the "KALMAN_SEARCH_RADIUS" parameter.
`static Map<String,Double>`	`DEFAULT_LINKING_FEATURE_PENALTIES` A default value for the "LINKING_FEATURE_PENALTIES" parameter.
`static double`	`DEFAULT_LINKING_MAX_DISTANCE` A default value for the "LINKING_MAX_DISTANCE" parameter.
`static Map<String,Double>`	`DEFAULT_MERGING_FEATURE_PENALTIES` A default value for the "MERGING_FEATURE_PENALTIES" parameter.
`static double`	`DEFAULT_MERGING_MAX_DISTANCE` A default value for the "MERGING_MAX_DISTANCE" parameter.
`static Map<String,Double>`	`DEFAULT_SPLITTING_FEATURE_PENALTIES` A default value for the "SPLITTING_FEATURE_PENALTIES" parameter.
`static double`	`DEFAULT_SPLITTING_MAX_DISTANCE` A default value for the `KEY_SPLITTING_MAX_DISTANCE` parameter.
`static String`	`KEY_ALLOW_GAP_CLOSING` Key for the parameter specifying whether we allow the detection of gap-closing events.
`static String`	`KEY_ALLOW_TRACK_MERGING` Key for the parameter specifying whether we allow the detection of merging events.
`static String`	`KEY_ALLOW_TRACK_SPLITTING` Key for the parameter specifying whether we allow the detection of splitting events.
`static String`	`KEY_ALTERNATIVE_LINKING_COST_FACTOR` Key for the parameter specifying the factor used to compute alternative linking costs.
`static String`	`KEY_BLOCKING_VALUE` Key for the parameter that stores the blocking value: cost for non-physical, forbidden links.
`static String`	`KEY_CUTOFF_PERCENTILE` Key for the cutoff percentile parameter.
`static String`	`KEY_GAP_CLOSING_FEATURE_PENALTIES` Key for the parameter specifying the feature penalties when detecting gap-closing events.
`static String`	`KEY_GAP_CLOSING_MAX_DISTANCE` Key for the parameter specifying the max gap-closing distance.
`static String`	`KEY_GAP_CLOSING_MAX_FRAME_GAP` Key for the parameter that specify the maximal number of frames to bridge when detecting gap closing.
`static String`	`KEY_KALMAN_SEARCH_RADIUS` Search radius for the Kalman tracker.
`static String`	`KEY_LINKING_FEATURE_PENALTIES` Key for the parameter specifying the feature penalties when linking particles.
`static String`	`KEY_LINKING_MAX_DISTANCE` Key for the parameter specifying the maximal linking distance.
`static String`	`KEY_MERGING_FEATURE_PENALTIES` Key for the parameter specifying the feature penalties when dealing with merging events.
`static String`	`KEY_MERGING_MAX_DISTANCE` Key for the parameter specifying the max merging distance.
`static String`	`KEY_SPLITTING_FEATURE_PENALTIES` Key for the parameter specifying the feature penalties when dealing with splitting events.
`static String`	`KEY_SPLITTING_MAX_DISTANCE` Key for the parameter specifying the max splitting distance.
`static String`	`TRACKER_SETTINGS_ALLOW_EVENT_ATTNAME`
`static String`	`TRACKER_SETTINGS_ALTERNATE_COST_FACTOR_ATTNAME`
`static String`	`TRACKER_SETTINGS_BLOCKING_VALUE_ATTNAME`
`static String`	`TRACKER_SETTINGS_CUTOFF_PERCENTILE_ATTNAME`
`static String`	`TRACKER_SETTINGS_DISTANCE_CUTOFF_ATTNAME`
`static String`	`TRACKER_SETTINGS_DISTANCE_CUTOFF_ELEMENT`
`static String`	`TRACKER_SETTINGS_FEATURE_ELEMENT`
`static String`	`TRACKER_SETTINGS_GAP_CLOSING_ELEMENT`
`static String`	`TRACKER_SETTINGS_LINKING_ELEMENT`
`static String`	`TRACKER_SETTINGS_MERGING_ELEMENT`
`static String`	`TRACKER_SETTINGS_SPLITTING_ELEMENT`
`static String`	`TRACKER_SETTINGS_TIME_CUTOFF_ATTNAME`
`static String`	`TRACKER_SETTINGS_TIME_CUTOFF_ELEMENT`
`static String`	`XML_ATTRIBUTE_TRACKER_NAME` The attribute name for the `SpotTracker` key when marshalling to or unmarhsalling from XML.

Constructor Summary

Constructors
Constructor and Description

TrackerKeys()

Constructors
Constructor and Description
`TrackerKeys()`

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

- Field Detail
  - TRACKER_SETTINGS_ALLOW_EVENT_ATTNAME
```
public static final String TRACKER_SETTINGS_ALLOW_EVENT_ATTNAME
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_ALTERNATE_COST_FACTOR_ATTNAME
```
public static final String TRACKER_SETTINGS_ALTERNATE_COST_FACTOR_ATTNAME
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_CUTOFF_PERCENTILE_ATTNAME
```
public static final String TRACKER_SETTINGS_CUTOFF_PERCENTILE_ATTNAME
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_BLOCKING_VALUE_ATTNAME
```
public static final String TRACKER_SETTINGS_BLOCKING_VALUE_ATTNAME
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_TIME_CUTOFF_ELEMENT
```
public static final String TRACKER_SETTINGS_TIME_CUTOFF_ELEMENT
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_TIME_CUTOFF_ATTNAME
```
public static final String TRACKER_SETTINGS_TIME_CUTOFF_ATTNAME
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_DISTANCE_CUTOFF_ELEMENT
```
public static final String TRACKER_SETTINGS_DISTANCE_CUTOFF_ELEMENT
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_DISTANCE_CUTOFF_ATTNAME
```
public static final String TRACKER_SETTINGS_DISTANCE_CUTOFF_ATTNAME
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_FEATURE_ELEMENT
```
public static final String TRACKER_SETTINGS_FEATURE_ELEMENT
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_LINKING_ELEMENT
```
public static final String TRACKER_SETTINGS_LINKING_ELEMENT
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_GAP_CLOSING_ELEMENT
```
public static final String TRACKER_SETTINGS_GAP_CLOSING_ELEMENT
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_MERGING_ELEMENT
```
public static final String TRACKER_SETTINGS_MERGING_ELEMENT
```
    See Also:
    
    Constant Field Values
  - TRACKER_SETTINGS_SPLITTING_ELEMENT
```
public static final String TRACKER_SETTINGS_SPLITTING_ELEMENT
```
    See Also:
    
    Constant Field Values
  - XML_ATTRIBUTE_TRACKER_NAME
```
public static final String XML_ATTRIBUTE_TRACKER_NAME
```
    The attribute name for the SpotTracker key when marshalling to or unmarhsalling from XML.
    
    See Also:
    
    Constant Field Values
  - KEY_LINKING_MAX_DISTANCE
```
public static final String KEY_LINKING_MAX_DISTANCE
```
    Key for the parameter specifying the maximal linking distance. The expected value must be a Double and should be expressed in physical units.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LINKING_MAX_DISTANCE
```
public static final double DEFAULT_LINKING_MAX_DISTANCE
```
    A default value for the "LINKING_MAX_DISTANCE" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_LINKING_FEATURE_PENALTIES
```
public static final String KEY_LINKING_FEATURE_PENALTIES
```
    Key for the parameter specifying the feature penalties when linking particles. Expected values should be a Map<String, Double> where the map keys are spot feature names.
    
    See Also:
    
    Spot.getFeature(String), Constant Field Values
  - DEFAULT_LINKING_FEATURE_PENALTIES
```
public static final Map<String,Double> DEFAULT_LINKING_FEATURE_PENALTIES
```
    A default value for the "LINKING_FEATURE_PENALTIES" parameter.
  - KEY_KALMAN_SEARCH_RADIUS
```
public static final String KEY_KALMAN_SEARCH_RADIUS
```
    Search radius for the Kalman tracker.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KALMAN_SEARCH_RADIUS
```
public static final double DEFAULT_KALMAN_SEARCH_RADIUS
```
    A default value for the "KALMAN_SEARCH_RADIUS" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_ALLOW_GAP_CLOSING
```
public static final String KEY_ALLOW_GAP_CLOSING
```
    Key for the parameter specifying whether we allow the detection of gap-closing events. Expected values are Booleans.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_GAP_CLOSING
```
public static final boolean DEFAULT_ALLOW_GAP_CLOSING
```
    A default value for the "ALLOW_GAP_CLOSING" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_GAP_CLOSING_MAX_FRAME_GAP
```
public static final String KEY_GAP_CLOSING_MAX_FRAME_GAP
```
    Key for the parameter that specify the maximal number of frames to bridge when detecting gap closing. Expected values are Integers greater than 0. A value of 1 means that a detection might be missed in 1 frame, and the track will not be broken. And so on.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GAP_CLOSING_MAX_FRAME_GAP
```
public static final int DEFAULT_GAP_CLOSING_MAX_FRAME_GAP
```
    A default value for the "MAX_FRAME_GAP" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_GAP_CLOSING_MAX_DISTANCE
```
public static final String KEY_GAP_CLOSING_MAX_DISTANCE
```
    Key for the parameter specifying the max gap-closing distance. Expected values are Doubles and should be expressed in physical units. If two spots, candidate for a gap-closing event, are found separated by a distance larger than this parameter value, gap-closing will not occur.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GAP_CLOSING_MAX_DISTANCE
```
public static final double DEFAULT_GAP_CLOSING_MAX_DISTANCE
```
    A default value for the "GAP_CLOSING_MAX_DISTANCE" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_GAP_CLOSING_FEATURE_PENALTIES
```
public static final String KEY_GAP_CLOSING_FEATURE_PENALTIES
```
    Key for the parameter specifying the feature penalties when detecting gap-closing events. Expected values should be a Map<String, Double> where the map keys are spot feature names.
    
    See Also:
    
    Spot.getFeature(String), Constant Field Values
  - DEFAULT_GAP_CLOSING_FEATURE_PENALTIES
```
public static final Map<String,Double> DEFAULT_GAP_CLOSING_FEATURE_PENALTIES
```
    A default value for the "GAP_CLOSING_FEATURE_PENALTIES" parameter.
  - KEY_ALLOW_TRACK_MERGING
```
public static final String KEY_ALLOW_TRACK_MERGING
```
    Key for the parameter specifying whether we allow the detection of merging events. Expected values are Booleans.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_TRACK_MERGING
```
public static final boolean DEFAULT_ALLOW_TRACK_MERGING
```
    A default value for the "ALLOW_TRACK_MERGING" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_MERGING_MAX_DISTANCE
```
public static final String KEY_MERGING_MAX_DISTANCE
```
    Key for the parameter specifying the max merging distance. Expected values are Doubles and should be expressed in physical units. If two spots, candidate for a merging event, are found separated by a distance larger than this parameter value, track merging will not occur.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MERGING_MAX_DISTANCE
```
public static final double DEFAULT_MERGING_MAX_DISTANCE
```
    A default value for the "MERGING_MAX_DISTANCE" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_MERGING_FEATURE_PENALTIES
```
public static final String KEY_MERGING_FEATURE_PENALTIES
```
    Key for the parameter specifying the feature penalties when dealing with merging events. Expected values should be a Map<String, Double> where the map keys are spot feature names.
    
    See Also:
    
    Spot.getFeature(String), Constant Field Values
  - DEFAULT_MERGING_FEATURE_PENALTIES
```
public static final Map<String,Double> DEFAULT_MERGING_FEATURE_PENALTIES
```
    A default value for the "MERGING_FEATURE_PENALTIES" parameter.
  - KEY_ALLOW_TRACK_SPLITTING
```
public static final String KEY_ALLOW_TRACK_SPLITTING
```
    Key for the parameter specifying whether we allow the detection of splitting events. Expected values are Booleans.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_TRACK_SPLITTING
```
public static final boolean DEFAULT_ALLOW_TRACK_SPLITTING
```
    A default value for the "ALLOW_TRACK_SPLITTING" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_SPLITTING_MAX_DISTANCE
```
public static final String KEY_SPLITTING_MAX_DISTANCE
```
    Key for the parameter specifying the max splitting distance. Expected values are Doubles and should be expressed in physical units. If two spots, candidate for a merging event, are found separated by a distance larger than this parameter value, track splitting will not occur.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SPLITTING_MAX_DISTANCE
```
public static final double DEFAULT_SPLITTING_MAX_DISTANCE
```
    A default value for the KEY_SPLITTING_MAX_DISTANCE parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_SPLITTING_FEATURE_PENALTIES
```
public static final String KEY_SPLITTING_FEATURE_PENALTIES
```
    Key for the parameter specifying the feature penalties when dealing with splitting events. Expected values should be a Map<String, Double> where the map keys are spot feature names.
    
    See Also:
    
    Spot.getFeature(String), Constant Field Values
  - DEFAULT_SPLITTING_FEATURE_PENALTIES
```
public static final Map<String,Double> DEFAULT_SPLITTING_FEATURE_PENALTIES
```
    A default value for the "SPLITTING_FEATURE_PENALTIES" parameter.
  - KEY_ALTERNATIVE_LINKING_COST_FACTOR
```
public static final String KEY_ALTERNATIVE_LINKING_COST_FACTOR
```
    Key for the parameter specifying the factor used to compute alternative linking costs. Expected values are Doubles.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ALTERNATIVE_LINKING_COST_FACTOR
```
public static final double DEFAULT_ALTERNATIVE_LINKING_COST_FACTOR
```
    A default value for the "ALTERNATIVE_LINKING_COST_FACTOR" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_CUTOFF_PERCENTILE
```
public static final String KEY_CUTOFF_PERCENTILE
```
    Key for the cutoff percentile parameter. Expected values are Doubles.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CUTOFF_PERCENTILE
```
public static final double DEFAULT_CUTOFF_PERCENTILE
```
    A default value for the "CUTOFF_PERCENTILE" parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_BLOCKING_VALUE
```
public static final String KEY_BLOCKING_VALUE
```
    Key for the parameter that stores the blocking value: cost for non-physical, forbidden links. Expected values are Doubles, and are typically very large.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOCKING_VALUE
```
public static final double DEFAULT_BLOCKING_VALUE
```
    A default value for the "BLOCKING_VALUE" parameter.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TrackerKeys
```
public TrackerKeys()
```

Class TrackerKeys

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRACKER_SETTINGS_ALLOW_EVENT_ATTNAME

TRACKER_SETTINGS_ALTERNATE_COST_FACTOR_ATTNAME

TRACKER_SETTINGS_CUTOFF_PERCENTILE_ATTNAME

TRACKER_SETTINGS_BLOCKING_VALUE_ATTNAME

TRACKER_SETTINGS_TIME_CUTOFF_ELEMENT

TRACKER_SETTINGS_TIME_CUTOFF_ATTNAME

TRACKER_SETTINGS_DISTANCE_CUTOFF_ELEMENT

TRACKER_SETTINGS_DISTANCE_CUTOFF_ATTNAME

TRACKER_SETTINGS_FEATURE_ELEMENT

TRACKER_SETTINGS_LINKING_ELEMENT

TRACKER_SETTINGS_GAP_CLOSING_ELEMENT

TRACKER_SETTINGS_MERGING_ELEMENT

TRACKER_SETTINGS_SPLITTING_ELEMENT

XML_ATTRIBUTE_TRACKER_NAME

KEY_LINKING_MAX_DISTANCE

DEFAULT_LINKING_MAX_DISTANCE

KEY_LINKING_FEATURE_PENALTIES

DEFAULT_LINKING_FEATURE_PENALTIES

KEY_KALMAN_SEARCH_RADIUS

DEFAULT_KALMAN_SEARCH_RADIUS

KEY_ALLOW_GAP_CLOSING

DEFAULT_ALLOW_GAP_CLOSING

KEY_GAP_CLOSING_MAX_FRAME_GAP

DEFAULT_GAP_CLOSING_MAX_FRAME_GAP

KEY_GAP_CLOSING_MAX_DISTANCE

DEFAULT_GAP_CLOSING_MAX_DISTANCE

KEY_GAP_CLOSING_FEATURE_PENALTIES

DEFAULT_GAP_CLOSING_FEATURE_PENALTIES

KEY_ALLOW_TRACK_MERGING

DEFAULT_ALLOW_TRACK_MERGING

KEY_MERGING_MAX_DISTANCE

DEFAULT_MERGING_MAX_DISTANCE

KEY_MERGING_FEATURE_PENALTIES

DEFAULT_MERGING_FEATURE_PENALTIES

KEY_ALLOW_TRACK_SPLITTING

DEFAULT_ALLOW_TRACK_SPLITTING

KEY_SPLITTING_MAX_DISTANCE

DEFAULT_SPLITTING_MAX_DISTANCE

KEY_SPLITTING_FEATURE_PENALTIES

DEFAULT_SPLITTING_FEATURE_PENALTIES

KEY_ALTERNATIVE_LINKING_COST_FACTOR

DEFAULT_ALTERNATIVE_LINKING_COST_FACTOR

KEY_CUTOFF_PERCENTILE

DEFAULT_CUTOFF_PERCENTILE

KEY_BLOCKING_VALUE

DEFAULT_BLOCKING_VALUE

Constructor Detail

TrackerKeys