fiji.plugin.trackmate.action

Class ComputeDistanceToRoiAction.DistanceToRoiFeature<T extends RealType<T> & NativeType<T>>

java.lang.Object

fiji.plugin.trackmate.action.ComputeDistanceToRoiAction.DistanceToRoiFeature<T>

All Implemented Interfaces:

FeatureAnalyzer, SpotAnalyzerFactory<T>, SpotAnalyzerFactoryBase<T>, TrackMateModule, SciJavaPlugin

Enclosing class:

ComputeDistanceToRoiAction

public static class ComputeDistanceToRoiAction.DistanceToRoiFeature<T extends RealType<T> & NativeType<T>>
extends Object
implements SpotAnalyzerFactory<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE
static String	NAME

Constructor Summary

Constructors

Constructor and Description
DistanceToRoiFeature()

Method Summary

Modifier and Type	Method and Description
SpotAnalyzer<T>	getAnalyzer(ImgPlus<T> img, int frame, int channel) Returns a configured SpotAnalyzer ready to operate on the given frame (0-based) and given channel (0-based).
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.
boolean	isManualFeature() Returns whether all the features declared in this FeatureAnalyzer are manual features.

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.features.spot.SpotAnalyzerFactoryBase

setNChannels

Methods inherited from interface fiji.plugin.trackmate.TrackMateModule

forbidMultithreading

Field Detail

FEATURE

public static final String FEATURE

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

DistanceToRoiFeature

public DistanceToRoiFeature()

Method Detail

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

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.

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.

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.

getAnalyzer

public SpotAnalyzer<T> getAnalyzer(ImgPlus<T> img,
                                   int frame,
                                   int channel)

Description copied from interface: SpotAnalyzerFactoryBase

Returns a configured SpotAnalyzer ready to operate on the given frame (0-based) and given channel (0-based).

This method will be called once per time-point and per channel of the source image. If a feature is defined independently of channels, implementation must care to skip generating several identical features when called on several channels.

Specified by:

getAnalyzer in interface SpotAnalyzerFactoryBase<T extends RealType<T> & NativeType<T>>

Parameters:

img - the 5D (X, Y, Z, C, T) source image. It is the responsibility of the implementation of this method to reslice it for the specified time-point and channel.

frame - the target frame to operate on.

channel - the target channel to operate on.