net.imagej.lut

Interface LUTService

All Superinterfaces:

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

All Known Implementing Classes:

DefaultLUTService

public interface LUTService
extends ImageJService

The LUTService loads ColorTables (i.e., Look-Up Tables or LUTs) from various data sources.

Author:

Barry DeZonia, Curtis Rueden

Method Summary

Modifier and Type	Method and Description
void	applyLUT(ColorTable colorTable, ImageDisplay display) Applies the given ColorTable to the active view of the specified ImageDisplay.
Dataset	createDataset(String title, ColorTable colorTable) Creates a new dataset showing the given ColorTable as a ramp.
Map<String,URL>	findLUTs() Finds the URLs of the LUT files known to ImageJ.
boolean	isLUT(File file) Gets whether the given file can be parsed as a color table by loadLUT(File).
ColorTable	loadLUT(File file) Loads a ColorTable from a File.
ColorTable	loadLUT(InputStream is) Loads a ColorTable from an input stream.
ColorTable	loadLUT(InputStream is, int length) Loads a ColorTable from an input stream with the given expected length.
ColorTable	loadLUT(URL url) Loads a ColorTable from a URL.

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

findLUTs

Map<String,URL> findLUTs()

Finds the URLs of the LUT files known to ImageJ. LUT files can reside within a JAR file on the classpath, or in the luts subdirectory of the application.

Returns:

A collection of URLs referencing the discovered LUT files.

isLUT

boolean isLUT(File file)

Gets whether the given file can be parsed as a color table by loadLUT(File).

This method is heuristic in nature, and does not offer a guarantee that calling loadLUT(File) will be successful. However, if it returns false, it is highly likely that the file is not parsable as a ColorTable.

loadLUT

ColorTable loadLUT(File file)
            throws IOException

Loads a ColorTable from a File.

Parameters:

file - The file from which the color table data will be read.

Returns:

The color table loaded from the given file.

Throws:

IOException - if there is a problem reading the color table

loadLUT

ColorTable loadLUT(URL url)
            throws IOException

Loads a ColorTable from a URL.

Parameters:

url - The URL from which the color table data will be read.

Returns:

The color table loaded from the given URL.

Throws:

IOException - if there is a problem reading the color table

loadLUT

ColorTable loadLUT(InputStream is)
            throws IOException

Loads a ColorTable from an input stream.

Does not close the input stream after reading the color table.

Parameters:

is - The stream from which the color table data will be read.

Returns:

The color table loaded from the given URL.

Throws:

IOException - if there is a problem reading the color table

loadLUT

ColorTable loadLUT(InputStream is,
                   int length)
            throws IOException

Loads a ColorTable from an input stream with the given expected length.

Parameters:

is - The stream from which the color table data will be read.

length - The expected length of the input stream.

Returns:

The color table loaded from the given URL.

Throws:

IOException - if there is a problem reading the color table

createDataset

Dataset createDataset(String title,
                      ColorTable colorTable)

Creates a new dataset showing the given ColorTable as a ramp.

Parameters:

title - The title of the new dataset.

colorTable - The color table to use.

Returns:

The newly created dataset.

applyLUT

void applyLUT(ColorTable colorTable,
              ImageDisplay display)

Applies the given ColorTable to the active view of the specified ImageDisplay.

Parameters:

colorTable -

display -