fiji.plugin.trackmate.tracking.jaqaman

Class SegmentTrackerFactory

java.lang.Object

fiji.plugin.trackmate.tracking.jaqaman.SegmentTrackerFactory

All Implemented Interfaces:

SpotTrackerFactory, TrackMateModule, SciJavaPlugin

Direct Known Subclasses:

AdvancedKalmanTrackerFactory, SparseLAPTrackerFactory

public abstract class SegmentTrackerFactory
extends Object
implements SpotTrackerFactory

Base class for trackers with split/merge actions.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	errorMessage

Constructor Summary

Constructors

Constructor and Description
SegmentTrackerFactory()

Method Summary

Modifier and Type	Method and Description
boolean	checkSettingsValidity(Map<String,Object> settings) Checks the validity of the given settings map for the tracker.
Map<String,Object>	getDefaultSettings() Returns a new default settings map suitable for the tracker Settings are instantiated with default values.
String	getErrorMessage() Returns a meaningful error message for the last action on this factory.
ImageIcon	getIcon() Returns the icon for this action.
boolean	marshall(Map<String,Object> settings, org.jdom2.Element element) Marshall into the Element the settings in the Map that relate to segment linking: gap-closing, merging segments, splitting segments.
String	toString(Map<String,Object> sm) A utility method that builds a string representation of a settings map owing to the currently selected tracker in this provider.
boolean	unmarshall(org.jdom2.Element element, Map<String,Object> settings) Un-marshall a JDom element to update a settings map, and sets the target tracker of this provider from the element.
boolean	unmarshallSegment(org.jdom2.Element element, Map<String,Object> settings, StringBuilder errorHolder)

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.tracking.SpotTrackerFactory

copy, create, getTrackerConfigurationPanel

Methods inherited from interface fiji.plugin.trackmate.TrackMateModule

forbidMultithreading, getInfoText, getKey, getName

Field Detail

errorMessage

protected String errorMessage

Constructor Detail

SegmentTrackerFactory

public SegmentTrackerFactory()

Method Detail

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.

marshall

public boolean marshall(Map<String,Object> settings,
                        org.jdom2.Element element)

Marshall into the Element the settings in the Map that relate to segment linking: gap-closing, merging segments, splitting segments.

Specified by:

marshall in interface SpotTrackerFactory

Returns:

true if marshalling was successful. If not, check SpotTrackerFactory.getErrorMessage()

unmarshallSegment

public boolean unmarshallSegment(org.jdom2.Element element,
                                 Map<String,Object> settings,
                                 StringBuilder errorHolder)

unmarshall

public boolean unmarshall(org.jdom2.Element element,
                          Map<String,Object> settings)

Description copied from interface: SpotTrackerFactory

Un-marshall a JDom element to update a settings map, and sets the target tracker of this provider from the element.

Concretely: the the specific settings map for the targeted tracker is updated from the element.

Specified by:

unmarshall in interface SpotTrackerFactory

Parameters:

element - the JDom element to read from.

settings - the map to update. Is cleared prior to updating, so that it contains only the parameters specific to the target tracker.

Returns:

true if unmarshalling was successful. If not, check SpotTrackerFactory.getErrorMessage()

toString

public String toString(Map<String,Object> sm)

Description copied from interface: SpotTrackerFactory

A utility method that builds a string representation of a settings map owing to the currently selected tracker in this provider.

Specified by:

toString in interface SpotTrackerFactory

Parameters:

sm - the map to echo.

Returns:

a string representation of the map.

getDefaultSettings

public Map<String,Object> getDefaultSettings()

Description copied from interface: SpotTrackerFactory

Returns a new default settings map suitable for the tracker Settings are instantiated with default values. is returned.

Specified by:

getDefaultSettings in interface SpotTrackerFactory

Returns:

a settings map.

checkSettingsValidity

public boolean checkSettingsValidity(Map<String,Object> settings)

Description copied from interface: SpotTrackerFactory

Checks the validity of the given settings map for the tracker. The validity check is strict: we check that all needed parameters are here and are of the right class, and that there is no extra unwanted parameters.

Specified by:

checkSettingsValidity in interface SpotTrackerFactory

Returns:

true if the settings map can be used with the target factory. If not, check SpotTrackerFactory.getErrorMessage()

getErrorMessage

public String getErrorMessage()

Description copied from interface: SpotTrackerFactory

Returns a meaningful error message for the last action on this factory.

Specified by:

getErrorMessage in interface SpotTrackerFactory

Returns:

an error message.

See Also:

SpotTrackerFactory.marshall(Map, Element), SpotTrackerFactory.unmarshall(Element, Map), SpotTrackerFactory.checkSettingsValidity(Map)