HyperStackDisplayer (Fiji Javadocs 2.0.0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.visualization.AbstractTrackMateModelView
- - fiji.plugin.trackmate.visualization.hyperstack.HyperStackDisplayer

All Implemented Interfaces:

ModelChangeListener, SelectionChangeListener, TrackMateModelView, EventListener
```
public class HyperStackDisplayer
extends AbstractTrackMateModelView
```

Field Summary

Fields
Modifier and Type Field and Description

protected ij.ImagePlus imp

static String KEY

protected SpotOverlay spotOverlay

protected TrackOverlay trackOverlay
- Fields inherited from class fiji.plugin.trackmate.visualization.AbstractTrackMateModelView
  displaySettings, model, selectionModel
- Fields inherited from interface fiji.plugin.trackmate.visualization.TrackMateModelView
  DEFAULT_COLOR_MAP, DEFAULT_DRAWING_DEPTH, DEFAULT_HIGHLIGHT_COLOR, DEFAULT_LIMIT_DRAWING_DEPTH, DEFAULT_SPOT_COLOR, DEFAULT_TRACK_COLOR, DEFAULT_TRACK_DISPLAY_DEPTH, DEFAULT_TRACK_DISPLAY_MODE, DEFAULT_UNASSIGNED_FEATURE_COLOR, DEFAULT_UNDEFINED_FEATURE_COLOR, KEY_COLOR, KEY_COLORMAP, KEY_DISPLAY_SPOT_NAMES, KEY_DRAWING_DEPTH, KEY_HIGHLIGHT_COLOR, KEY_LIMIT_DRAWING_DEPTH, KEY_SPOT_COLORING, KEY_SPOT_RADIUS_RATIO, KEY_SPOTS_VISIBLE, KEY_TRACK_COLORING, KEY_TRACK_DISPLAY_DEPTH, KEY_TRACK_DISPLAY_MODE, KEY_TRACKS_VISIBLE, TRACK_DISPLAY_MODE_DESCRIPTION, TRACK_DISPLAY_MODE_LOCAL, TRACK_DISPLAY_MODE_LOCAL_BACKWARD, TRACK_DISPLAY_MODE_LOCAL_BACKWARD_QUICK, TRACK_DISPLAY_MODE_LOCAL_FORWARD, TRACK_DISPLAY_MODE_LOCAL_FORWARD_QUICK, TRACK_DISPLAY_MODE_LOCAL_QUICK, TRACK_DISPLAY_MODE_SELECTION_ONLY, TRACK_DISPLAY_MODE_WHOLE

Fields
Modifier and Type	Field and Description
`protected ij.ImagePlus`	`imp`
`static String`	`KEY`
`protected SpotOverlay`	`spotOverlay`
`protected TrackOverlay`	`trackOverlay`

Constructor Summary

Constructors
Constructor and Description
`HyperStackDisplayer(Model model, SelectionModel selectionModel)`
`HyperStackDisplayer(Model model, SelectionModel selectionModel, ij.ImagePlus imp)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOverlay(ij.gui.Roi overlay)`
`void`	`centerViewOn(Spot spot)` Centers the view on the given spot.
`void`	`clear()` Removes any overlay (for spots or tracks) from this displayer.
`protected SpotOverlay`	`createSpotOverlay()` Hook for subclassers.
`protected TrackOverlay`	`createTrackOverlay()` Hook for subclassers.
`ij.ImagePlus`	`getImp()` Exposes the `ImagePlus` on which the model is drawn by this view.
`String`	`getKey()` Returns the unique key that identifies this view.
`SelectionModel`	`getSelectionModel()`
`void`	`modelChanged(ModelChangeEvent event)` This notification is fired when a `Model` has been changed.
`void`	`refresh()` Refreshes the displayer display with current model.
`void`	`render()` Initializes this displayer and render it according to its concrete implementation.
`void`	`selectionChanged(SelectionChangeEvent event)` This needs to be overriden for concrete implementation to display selection.
`void`	`setDisplaySettings(String key, Object value)` Set a display parameter.

Methods inherited from class fiji.plugin.trackmate.visualization.AbstractTrackMateModelView
getDisplaySettings, getDisplaySettings, getModel, initDisplaySettings

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

- Field Detail
  - imp
```
protected final ij.ImagePlus imp
```
  - spotOverlay
```
protected SpotOverlay spotOverlay
```
  - trackOverlay
```
protected TrackOverlay trackOverlay
```
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HyperStackDisplayer
```
public HyperStackDisplayer(Model model,
                           SelectionModel selectionModel,
                           ij.ImagePlus imp)
```
  - HyperStackDisplayer
```
public HyperStackDisplayer(Model model,
                           SelectionModel selectionModel)
```
- Method Detail
  - createSpotOverlay
```
protected SpotOverlay createSpotOverlay()
```
    Hook for subclassers. Instantiate here the overlay you want to use for the spots.
    
    Returns:
    
    the spot overlay
  - createTrackOverlay
```
protected TrackOverlay createTrackOverlay()
```
    Hook for subclassers. Instantiate here the overlay you want to use for the spots.
    
    Returns:
    
    the track overlay
  - getImp
```
public ij.ImagePlus getImp()
```
    Exposes the ImagePlus on which the model is drawn by this view.
    
    Returns:
    
    the ImagePlus used in this view.
  - modelChanged
```
public void modelChanged(ModelChangeEvent event)
```
    Description copied from interface: ModelChangeListener
    
    This notification is fired when a Model has been changed.
    
    Parameters:
    
    event - the ModelChangeEvent.
  - selectionChanged
```
public void selectionChanged(SelectionChangeEvent event)
```
    Description copied from class: AbstractTrackMateModelView
    
    This needs to be overriden for concrete implementation to display selection.
    
    Specified by:
    
    selectionChanged in interface SelectionChangeListener
    
    Overrides:
    
    selectionChanged in class AbstractTrackMateModelView
    
    Parameters:
    
    event - the event that characterizes the change.
  - centerViewOn
```
public void centerViewOn(Spot spot)
```
    Description copied from interface: TrackMateModelView
    
    Centers the view on the given spot.
  - render
```
public void render()
```
    Description copied from interface: TrackMateModelView
    
    Initializes this displayer and render it according to its concrete implementation.
  - refresh
```
public void refresh()
```
    Description copied from interface: TrackMateModelView
    
    Refreshes the displayer display with current model. If the underlying model was modified, or the display settings were changed, calling this method should be enough to update the display with changes.
    
    See Also:
    
    TrackMateModelView.setDisplaySettings(String, Object)
  - clear
```
public void clear()
```
    Description copied from interface: TrackMateModelView
    
    Removes any overlay (for spots or tracks) from this displayer.
  - addOverlay
```
public void addOverlay(ij.gui.Roi overlay)
```
  - getSelectionModel
```
public SelectionModel getSelectionModel()
```
  - setDisplaySettings
```
public void setDisplaySettings(String key,
                               Object value)
```
    Description copied from interface: TrackMateModelView
    
    Set a display parameter.
    
    Specified by:
    
    setDisplaySettings in interface TrackMateModelView
    
    Overrides:
    
    setDisplaySettings in class AbstractTrackMateModelView
    
    Parameters:
    
    key - the key of the parameter to change.
    
    value - the value for the display parameter
  - getKey
```
public String getKey()
```
    Description copied from interface: TrackMateModelView
    
    Returns the unique key that identifies this view.
    Careful: this key must be the same that for the ViewFactory that can instantiates this view. This is to facilitate saving/loading.
    
    Returns:
    
    the key, as a String.

Class HyperStackDisplayer

Field Summary

Fields inherited from class fiji.plugin.trackmate.visualization.AbstractTrackMateModelView

Fields inherited from interface fiji.plugin.trackmate.visualization.TrackMateModelView

Constructor Summary

Method Summary

Methods inherited from class fiji.plugin.trackmate.visualization.AbstractTrackMateModelView

Methods inherited from class java.lang.Object

Field Detail

imp

spotOverlay

trackOverlay

KEY

Constructor Detail

HyperStackDisplayer

HyperStackDisplayer

Method Detail

createSpotOverlay

createTrackOverlay

getImp

modelChanged

selectionChanged

centerViewOn

render

refresh

clear

addOverlay

getSelectionModel

setDisplaySettings

getKey