DefaultLUTService (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.service.AbstractService
    - - net.imagej.lut.DefaultLUTService

All Implemented Interfaces:

Comparable<Prioritized>, ImageJService, LUTService, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Service, Versioned
```
public class DefaultLUTService
extends AbstractService
implements LUTService
```
The DefaultLUTService loads ColorTables from files (hosted locally or externally).

Author:

Barry DeZonia, Wayne Rasband, Curtis Rueden

Constructor Summary

Constructors
Constructor and Description

DefaultLUTService()

Constructors
Constructor and Description
`DefaultLUTService()`

Method Summary

All Methods Instance Methods Concrete Methods
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 `URL`s of the LUT files known to ImageJ.
`void`	`initialize()`
`boolean`	`isLUT(File file)` Gets whether the given file can be parsed as a color table by `LUTService.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 class org.scijava.service.AbstractService
getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context

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

Methods inherited from interface org.scijava.service.Service
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

- Constructor Detail
  - DefaultLUTService
```
public DefaultLUTService()
```
- Method Detail
  - findLUTs
```
public Map<String,URL> findLUTs()
```
    Description copied from interface: LUTService
    
    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.
    
    Specified by:
    
    findLUTs in interface LUTService
    
    Returns:
    
    A collection of URLs referencing the discovered LUT files.
  - isLUT
```
public boolean isLUT(File file)
```
    Description copied from interface: LUTService
    
    Gets whether the given file can be parsed as a color table by LUTService.loadLUT(File).
    This method is heuristic in nature, and does not offer a guarantee that calling LUTService.loadLUT(File) will be successful. However, if it returns false, it is highly likely that the file is not parsable as a ColorTable.
    
    Specified by:
    
    isLUT in interface LUTService
  - loadLUT
```
public ColorTable loadLUT(File file)
                   throws IOException
```
    Description copied from interface: LUTService
    
    Loads a ColorTable from a File.
    
    Specified by:
    
    loadLUT in interface LUTService
    
    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
```
public ColorTable loadLUT(URL url)
                   throws IOException
```
    Description copied from interface: LUTService
    
    Loads a ColorTable from a URL.
    
    Specified by:
    
    loadLUT in interface LUTService
    
    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
```
public ColorTable loadLUT(InputStream is)
                   throws IOException
```
    Description copied from interface: LUTService
    
    Loads a ColorTable from an input stream.
    Does not close the input stream after reading the color table.
    
    Specified by:
    
    loadLUT in interface LUTService
    
    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
```
public ColorTable loadLUT(InputStream is,
                          int length)
                   throws IOException
```
    Description copied from interface: LUTService
    
    Loads a ColorTable from an input stream with the given expected length.
    
    Specified by:
    
    loadLUT in interface LUTService
    
    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
```
public Dataset createDataset(String title,
                             ColorTable colorTable)
```
    Description copied from interface: LUTService
    
    Creates a new dataset showing the given ColorTable as a ramp.
    
    Specified by:
    
    createDataset in interface LUTService
    
    Parameters:
    
    title - The title of the new dataset.
    
    colorTable - The color table to use.
    
    Returns:
    
    The newly created dataset.
  - applyLUT
```
public void applyLUT(ColorTable colorTable,
                     ImageDisplay display)
```
    Description copied from interface: LUTService
    
    Applies the given ColorTable to the active view of the specified ImageDisplay.
    
    Specified by:
    
    applyLUT in interface LUTService
  - initialize
```
public void initialize()
```
    Specified by:
    
    initialize in interface Initializable
    
    Specified by:
    
    initialize in interface Service

Class DefaultLUTService

Constructor Summary

Method Summary

Methods inherited from class org.scijava.service.AbstractService

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Disposable

Constructor Detail

DefaultLUTService

Method Detail

findLUTs

isLUT

loadLUT

loadLUT

loadLUT

loadLUT

createDataset

applyLUT

initialize