fiji.plugin.trackmate.action.autonaming

Interface AutoNamingRule

All Known Implementing Classes:

CopyTrackNameNamingRule, DefaultAutoNamingRule

public interface AutoNamingRule

Method Summary

Modifier and Type	Method and Description
String	getInfoText() Returns a html string containing a descriptive information about this module.
void	nameBranches(Spot mother, Collection<Spot> siblings) Sets the name of individual branches possibly based on the mother spot name.
void	nameRoot(Spot root, TrackModel model) Sets the name of the root.
default void	nameSpot(Spot current, Spot predecessor) Name a spot within a branch, based on the name of its predecessor in the same branch.

Method Detail

nameRoot

void nameRoot(Spot root,
              TrackModel model)

Sets the name of the root. The specified spot is the first spot of the branch with no incoming edge.

Parameters:

root - the spot to name.

model - the TrackModel the spot belongs to.

nameBranches

void nameBranches(Spot mother,
                  Collection<Spot> siblings)

Sets the name of individual branches possibly based on the mother spot name.

Parameters:

mother - the predecessor spot of the siblings.

siblings - the collection of spots to name. They are all successors of the mother spot.

nameSpot

default void nameSpot(Spot current,
                      Spot predecessor)

Name a spot within a branch, based on the name of its predecessor in the same branch.

Parameters:

current - the spot to name.

predecessor - the spot that precedes it in the track.

getInfoText

String getInfoText()

Returns a html string containing a descriptive information about this module.

Returns:

a html string.