FeatureModel (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.FeatureModel

```
public class FeatureModel
extends Object
```
This class represents the part of the Model that is in charge of dealing with spot features and track features.

Author:

Jean-Yves Tinevez, 2011, 2012. Revised December 2020.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FeatureModel(Model model)
Instantiates a new feature model.

Constructors
Modifier	Constructor and Description
`protected`	`FeatureModel(Model model)` Instantiates a new feature model.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`declareEdgeFeatures(Collection<String> features, Map<String,String> featureNames, Map<String,String> featureShortNames, Map<String,Dimension> featureDimensions, Map<String,Boolean> isIntFeature)` Declares edge features, by specifying their name, short name and dimension.
`void`	`declareSpotFeatures(Collection<String> features, Map<String,String> featureNames, Map<String,String> featureShortNames, Map<String,Dimension> featureDimensions, Map<String,Boolean> isIntFeature)` Declares spot features, by specifying their names, short name and dimension.
`void`	`declareTrackFeatures(Collection<String> features, Map<String,String> featureNames, Map<String,String> featureShortNames, Map<String,Dimension> featureDimensions, Map<String,Boolean> isIntFeature)` Declares track features, by specifying their names, short name and dimension.
`String`	`echo()` Echoes the full content of this `FeatureModel`.
`Double`	`getEdgeFeature(org.jgrapht.graph.DefaultWeightedEdge edge, String featureName)`
`Map<String,Dimension>`	`getEdgeFeatureDimensions()` Returns the dimension mapping of the edge features that are dealt with in this model.
`Map<String,Boolean>`	`getEdgeFeatureIsInt()` Returns the map that states whether the target feature is integer values (`true`) or double valued (`false`).
`Map<String,String>`	`getEdgeFeatureNames()` Returns the name mapping of the edge features that are dealt with in this model.
`Collection<String>`	`getEdgeFeatures()` Returns edge features as declared in this model.
`Map<String,String>`	`getEdgeFeatureShortNames()` Returns the short name mapping of the edge features that are dealt with in this model.
`Map<String,Dimension>`	`getSpotFeatureDimensions()` Returns the dimension mapping of the spot features that are dealt with in this model.
`Map<String,Boolean>`	`getSpotFeatureIsInt()` Returns the map that states whether the target feature is integer values (`true`) or double valued (`false`).
`Map<String,String>`	`getSpotFeatureNames()` Returns the name mapping of the spot features that are dealt with in this model.
`Collection<String>`	`getSpotFeatures()` Returns spot features as declared in this model.
`Map<String,String>`	`getSpotFeatureShortNames()` Returns the short name mapping of the spot features that are dealt with in this model.
`Double`	`getTrackFeature(Integer trackID, String feature)` Returns the numerical value of the specified track feature for the specified track.
`Map<String,Dimension>`	`getTrackFeatureDimensions()` Returns the dimension mapping of the track features that are dealt with in this model.
`Map<String,Boolean>`	`getTrackFeatureIsInt()` Returns the map that states whether the target feature is integer values (`true`) or double valued (`false`).
`Map<String,String>`	`getTrackFeatureNames()` Returns the name mapping of the track features that are dealt with in this model.
`Collection<String>`	`getTrackFeatures()` Returns the track features that are dealt with in this model.
`Map<String,String>`	`getTrackFeatureShortNames()` Returns the short name mapping of the track features that are dealt with in this model.
`Map<String,double[]>`	`getTrackFeatureValues()` Returns the map of all track features declared for all tracks of the model.
`void`	`putEdgeFeature(org.jgrapht.graph.DefaultWeightedEdge edge, String feature, Double value)` Stores a numerical feature for an edge of this model.
`void`	`putTrackFeature(Integer trackID, String feature, Double value)` Stores a track numerical feature.
`void`	`removeEdgeFeature(org.jgrapht.graph.DefaultWeightedEdge edge, String feature)` Remove the value of the designated feature for the specified edge.
`void`	`removeTrackFeature(Integer trackID, String feature)` Remove the value of the designated feature for the track with the specified ID.
`String`	`toString()`

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

- Constructor Detail
  - FeatureModel
```
protected FeatureModel(Model model)
```
    Instantiates a new feature model. The basic spot features (POSITON_*, RADIUS, FRAME, QUALITY) are declared. Edge and track feature declarations are left blank.
    
    Parameters:
    
    model - the parent Model.
- Method Detail
  - putEdgeFeature
```
public void putEdgeFeature(org.jgrapht.graph.DefaultWeightedEdge edge,
                           String feature,
                           Double value)
```
    Stores a numerical feature for an edge of this model.
    Note that no checks are made to ensures that the edge exists in the TrackModel, and that the feature is declared in this FeatureModel.
    
    Parameters:
    
    edge - the edge whose features to update.
    
    feature - the feature.
    
    value - the feature value
  - getEdgeFeature
```
public Double getEdgeFeature(org.jgrapht.graph.DefaultWeightedEdge edge,
                             String featureName)
```
  - removeEdgeFeature
```
public void removeEdgeFeature(org.jgrapht.graph.DefaultWeightedEdge edge,
                              String feature)
```
    Remove the value of the designated feature for the specified edge.
    
    Parameters:
    
    edge - the edge
    
    feature - the feature
  - getEdgeFeatures
```
public Collection<String> getEdgeFeatures()
```
    Returns edge features as declared in this model.
    
    Returns:
    
    the edge features.
  - declareEdgeFeatures
```
public void declareEdgeFeatures(Collection<String> features,
                                Map<String,String> featureNames,
                                Map<String,String> featureShortNames,
                                Map<String,Dimension> featureDimensions,
                                Map<String,Boolean> isIntFeature)
```
    Declares edge features, by specifying their name, short name and dimension. An IllegalArgumentException will be thrown if any of the map misses a feature.
    
    Parameters:
    
    features - the list of edge features to register.
    
    featureNames - the name of these features.
    
    featureShortNames - the short name of these features.
    
    featureDimensions - the dimension of these features.
    
    isIntFeature - whether some of these features are made of ints ( true) or doubles (false ).
  - getEdgeFeatureNames
```
public Map<String,String> getEdgeFeatureNames()
```
    Returns the name mapping of the edge features that are dealt with in this model.
    
    Returns:
    
    the map of edge feature names.
  - getEdgeFeatureShortNames
```
public Map<String,String> getEdgeFeatureShortNames()
```
    Returns the short name mapping of the edge features that are dealt with in this model.
    
    Returns:
    
    the map of edge short names.
  - getEdgeFeatureDimensions
```
public Map<String,Dimension> getEdgeFeatureDimensions()
```
    Returns the dimension mapping of the edge features that are dealt with in this model.
    
    Returns:
    
    the map of edge feature dimensions.
  - getEdgeFeatureIsInt
```
public Map<String,Boolean> getEdgeFeatureIsInt()
```
    Returns the map that states whether the target feature is integer values (true) or double valued (false).
    
    Returns:
    
    the map of isInt flag.
  - getTrackFeatures
```
public Collection<String> getTrackFeatures()
```
    Returns the track features that are dealt with in this model.
    
    Returns:
    
    the collection of track features managed in this model.
  - declareTrackFeatures
```
public void declareTrackFeatures(Collection<String> features,
                                 Map<String,String> featureNames,
                                 Map<String,String> featureShortNames,
                                 Map<String,Dimension> featureDimensions,
                                 Map<String,Boolean> isIntFeature)
```
    Declares track features, by specifying their names, short name and dimension. An IllegalArgumentException will be thrown if any of the map misses a feature.
    
    Parameters:
    
    features - the list of track feature to register.
    
    featureNames - the name of these features.
    
    featureShortNames - the short name of these features.
    
    featureDimensions - the dimension of these features.
    
    isIntFeature - whether some of these features are made of ints ( true) or doubles (false ).
  - getTrackFeatureNames
```
public Map<String,String> getTrackFeatureNames()
```
    Returns the name mapping of the track features that are dealt with in this model.
    
    Returns:
    
    the feature name.
  - getTrackFeatureShortNames
```
public Map<String,String> getTrackFeatureShortNames()
```
    Returns the short name mapping of the track features that are dealt with in this model.
    
    Returns:
    
    the feature short name.
  - getTrackFeatureDimensions
```
public Map<String,Dimension> getTrackFeatureDimensions()
```
    Returns the dimension mapping of the track features that are dealt with in this model.
    
    Returns:
    
    the feature dimension.
  - getTrackFeatureIsInt
```
public Map<String,Boolean> getTrackFeatureIsInt()
```
    Returns the map that states whether the target feature is integer values (true) or double valued (false).
    
    Returns:
    
    the map of isInt flag.
  - putTrackFeature
```
public void putTrackFeature(Integer trackID,
                            String feature,
                            Double value)
```
    Stores a track numerical feature.
    Note that no checks are made to ensures that the track ID exists in the TrackModel, and that the feature is declared in this FeatureModel.
    
    Parameters:
    
    trackID - the ID of the track. It must be an existing track ID.
    
    feature - the feature.
    
    value - the feature value.
  - removeTrackFeature
```
public void removeTrackFeature(Integer trackID,
                               String feature)
```
    Remove the value of the designated feature for the track with the specified ID.
    
    Parameters:
    
    trackID - the track ID
    
    feature - the feature
  - getTrackFeature
```
public Double getTrackFeature(Integer trackID,
                              String feature)
```
    Returns the numerical value of the specified track feature for the specified track.
    
    Parameters:
    
    trackID - the track ID to quest.
    
    feature - the desired feature.
    
    Returns:
    
    the value of the specified feature.
  - getTrackFeatureValues
```
public Map<String,double[]> getTrackFeatureValues()
```
    Returns the map of all track features declared for all tracks of the model.
    
    Returns:
    
    a new mapping of feature vs its numerical values.
  - declareSpotFeatures
```
public void declareSpotFeatures(Collection<String> features,
                                Map<String,String> featureNames,
                                Map<String,String> featureShortNames,
                                Map<String,Dimension> featureDimensions,
                                Map<String,Boolean> isIntFeature)
```
    Declares spot features, by specifying their names, short name and dimension. An IllegalArgumentException will be thrown if any of the map misses a feature.
    
    Parameters:
    
    features - the list of spot feature to register.
    
    featureNames - the name of these features.
    
    featureShortNames - the short name of these features.
    
    featureDimensions - the dimension of these features.
    
    isIntFeature - whether some of these features are made of ints ( true) or doubles (false ).
  - getSpotFeatures
```
public Collection<String> getSpotFeatures()
```
    Returns spot features as declared in this model.
    
    Returns:
    
    the spot features.
  - getSpotFeatureNames
```
public Map<String,String> getSpotFeatureNames()
```
    Returns the name mapping of the spot features that are dealt with in this model.
    
    Returns:
    
    the map of spot feature names.
  - getSpotFeatureShortNames
```
public Map<String,String> getSpotFeatureShortNames()
```
    Returns the short name mapping of the spot features that are dealt with in this model.
    
    Returns:
    
    the map of spot short names.
  - getSpotFeatureDimensions
```
public Map<String,Dimension> getSpotFeatureDimensions()
```
    Returns the dimension mapping of the spot features that are dealt with in this model.
    
    Returns:
    
    the map of spot feature dimensions.
  - getSpotFeatureIsInt
```
public Map<String,Boolean> getSpotFeatureIsInt()
```
    Returns the map that states whether the target feature is integer values (true) or double valued (false).
    
    Returns:
    
    the map of isInt flag.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - echo
```
public String echo()
```
    Echoes the full content of this FeatureModel.
    
    Returns:
    
    a String representation of the full content of this model.

Class FeatureModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FeatureModel

Method Detail

putEdgeFeature

getEdgeFeature

removeEdgeFeature

getEdgeFeatures

declareEdgeFeatures

getEdgeFeatureNames

getEdgeFeatureShortNames

getEdgeFeatureDimensions

getEdgeFeatureIsInt

getTrackFeatures

declareTrackFeatures

getTrackFeatureNames

getTrackFeatureShortNames

getTrackFeatureDimensions

getTrackFeatureIsInt

putTrackFeature

removeTrackFeature

getTrackFeature

getTrackFeatureValues

declareSpotFeatures

getSpotFeatures

getSpotFeatureNames

getSpotFeatureShortNames

getSpotFeatureDimensions

getSpotFeatureIsInt

toString

echo