net.imagej.display

Interface ImageDisplayService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, ImageJService, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, Service, Versioned

All Known Implementing Classes:

DefaultImageDisplayService

public interface ImageDisplayService
extends ImageJService

Interface for services that work with ImageDisplays.

Author:

Barry DeZonia, Curtis Rueden, Grant Harris

Method Summary

Modifier and Type	Method and Description
default DatasetView	createDatasetView(Dataset dataset) Creates a new DatasetView wrapping the given dataset.
DataView	createDataView(Data data) Creates a new DataView wrapping the given data object.
default ImageDisplay	createImageDisplay(Data data) Creates an ImageDisplay for the given data object.
default ImageDisplay	createImageDisplay(DataView dataView) Creates an ImageDisplay for the given DataView.
default ImageDisplay	createImageDisplay(String name, Data data) Creates an ImageDisplay for the given data object.
default ImageDisplay	createImageDisplay(String name, DataView dataView) Creates an ImageDisplay for the given DataView.
default Dataset	getActiveDataset() Gets the active Dataset, if any, of the currently active ImageDisplay.
default Dataset	getActiveDataset(ImageDisplay display) Gets the active Dataset, if any, of the given ImageDisplay.
default DatasetView	getActiveDatasetView() Gets the active DatasetView, if any, of the currently active ImageDisplay.
default DatasetView	getActiveDatasetView(ImageDisplay display) Gets the active DatasetView, if any, of the given ImageDisplay.
ImageDisplay	getActiveImageDisplay() Gets the currently active ImageDisplay.
default Position	getActivePosition() Gets the active Position, if any, of the currently active ImageDisplay.
default Position	getActivePosition(ImageDisplay display) Gets the active Position, if any, of the active DatasetView in the given ImageDisplay.
List<? extends DataView>	getDataViews() Gets the list of available DataViews.
DisplayService	getDisplayService()
EventService	getEventService()
List<ImageDisplay>	getImageDisplays() Gets a list of all available ImageDisplays.
PluginService	getPluginService()

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

getEventService

EventService getEventService()

getPluginService

PluginService getPluginService()

getDisplayService

DisplayService getDisplayService()

createDataView

DataView createDataView(Data data)

Creates a new DataView wrapping the given data object.

createDatasetView

default DatasetView createDatasetView(Dataset dataset)

Creates a new DatasetView wrapping the given dataset.

createImageDisplay

default ImageDisplay createImageDisplay(Data data)

Creates an ImageDisplay for the given data object. This is a more specific type-safe version of DisplayService.createDisplay(Object).

Parameters:

data - The data object for which a display should be created. The object is wrapped to a DataView and added to a new ImageDisplay.

Returns:

Newly created ImageDisplay containing the given data object.

See Also:

DisplayService.createDisplay(Object)

createImageDisplay

default ImageDisplay createImageDisplay(String name,
                                        Data data)

Creates an ImageDisplay for the given data object. This is a more specific type-safe version of DisplayService.createDisplay(Object).

Parameters:

name - The name to be assigned to the display.

data - The data object for which a display should be created. The object is wrapped to a DataView and added to the new ImageDisplay.

Returns:

Newly created ImageDisplay containing the given data object.

See Also:

DisplayService.createDisplay(String, Object)

createImageDisplay

default ImageDisplay createImageDisplay(DataView dataView)

Creates an ImageDisplay for the given DataView. This is a more specific type-safe version of DisplayService.createDisplay(Object).

Parameters:

dataView - The DataView for which a display should be created. The view is added to the new ImageDisplay.

Returns:

Newly created ImageDisplay containing the given DataView.

See Also:

DisplayService.createDisplay(Object)

createImageDisplay

default ImageDisplay createImageDisplay(String name,
                                        DataView dataView)

Creates an ImageDisplay for the given DataView. This is a more specific type-safe version of DisplayService.createDisplay(Object).

Parameters:

name - The name to be assigned to the display.

dataView - The DataView for which a display should be created. The view is added to the new ImageDisplay.

Returns:

Newly created ImageDisplay containing the given DataView.

See Also:

DisplayService.createDisplay(Object)

getDataViews

List<? extends DataView> getDataViews()

Gets the list of available DataViews. The list will contain one uninitialized instance of each DataView implementation known to the PluginService.

getActiveImageDisplay

ImageDisplay getActiveImageDisplay()

Gets the currently active ImageDisplay.

getActiveDataset

default Dataset getActiveDataset()

Gets the active Dataset, if any, of the currently active ImageDisplay.

getActiveDatasetView

default DatasetView getActiveDatasetView()

Gets the active DatasetView, if any, of the currently active ImageDisplay.

getActivePosition

default Position getActivePosition()

Gets the active Position, if any, of the currently active ImageDisplay.

getActiveDataset

default Dataset getActiveDataset(ImageDisplay display)

Gets the active Dataset, if any, of the given ImageDisplay.

getActiveDatasetView

default DatasetView getActiveDatasetView(ImageDisplay display)

Gets the active DatasetView, if any, of the given ImageDisplay.

getImageDisplays

List<ImageDisplay> getImageDisplays()

Gets a list of all available ImageDisplays.

getActivePosition

default Position getActivePosition(ImageDisplay display)

Gets the active Position, if any, of the active DatasetView in the given ImageDisplay.