voltex

Class VoltexVolume

java.lang.Object

ij3d.Volume

voltex.VoltexVolume

Direct Known Subclasses:

Mask

public class VoltexVolume
extends Volume

This class encapsulates an image stack and provides various methods for retrieving data. It is possible to control the loaded color channels of RGB images, and to specify whether or not to average several channels (and merge them in this way into one byte per pixel). Depending on these settings, and on the type of image given at construction time, the returned data type is one of INT_DATA or BYTE_DATA.

Author:

Benjamin Schmid

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	VoltexVolume.VoltexLoader Abstract interface for the loader classes.

Nested classes/interfaces inherited from class ij3d.Volume

Volume.AverageByteLoader, Volume.ByteImage, Volume.ByteLoader, Volume.InputImage, Volume.IntImage, Volume.IntLoader, Volume.Loader, Volume.SaturatedIntLoader

Field Summary

Fields

Modifier and Type	Field and Description
protected voltex.VoltexVolume.ComponentCreator	compCreator
protected static ColorModel	greyCM The ColorModel used for 8-bit textures
protected static ColorModel	rgbCM The ColorModel used for RGB textures

Fields inherited from class ij3d.Volume

average, BYTE_DATA, channels, dataType, image, imp, INT_DATA, loader, maxCoord, minCoord, pd, ph, pw, saturatedVolumeRendering, xDim, yDim, zDim

Constructor Summary

Constructors

Constructor and Description
VoltexVolume(ij.ImagePlus imp) Initializes this Volume with the specified image.
VoltexVolume(ij.ImagePlus imp, boolean[] ch) Initializes this Volume with the specified image and channels.

Method Summary

Modifier and Type	Method and Description
void	clear()
org.jogamp.java3d.ImageComponent2D	getImageComponentX(int index)
org.jogamp.java3d.ImageComponent2D	getImageComponentY(int index)
org.jogamp.java3d.ImageComponent2D	getImageComponentZ(int index)
protected void	initVoltexLoader() Init the loader, based on the currently set data type, which is either INT_DATA or BYTE_DATA.
protected static int	powerOfTwo(int value) Calculate the next power of two to the given value.
void	restore(String path)
boolean	setAlphaLUTFullyOpaque() Set the alpha channel to fully opaque.
boolean	setAverage(boolean average) If true, build an average byte from the specified channels (for each pixel).
boolean	setChannels(boolean[] ch) Sets the channels which are to be used in this volume rendering.
void	setImage(ij.ImagePlus imp, boolean[] ch)
boolean	setLUTs(int[] r, int[] g, int[] b, int[] a) Set the lookup tables for this volume rendering.
void	setNoCheckNoUpdate(int x, int y, int z, int v)
boolean	setSaturatedVolumeRendering(boolean b) If true, saturate the channels of RGB images; the RGB values of each pixels are scaled so that at least one of the values is 255, the alpha value is the average of the original RGB values.
void	swap(String path)
void	updateData()

Methods inherited from class ij3d.Volume

getAlphaLUT, getAverage, getBlueLUT, getDataType, getGreenLUT, getImagePlus, getRedLUT, initDataType, initLoader, isAverage, isDefaultLUT, isSaturatedVolumeRendering, load, loadWithLUT, set, setNoCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

greyCM

protected static final ColorModel greyCM

The ColorModel used for 8-bit textures

rgbCM

protected static final ColorModel rgbCM

The ColorModel used for RGB textures

compCreator

protected voltex.VoltexVolume.ComponentCreator compCreator

Constructor Detail

VoltexVolume

public VoltexVolume(ij.ImagePlus imp)

Initializes this Volume with the specified image. All channels are used.

Parameters:

imp -

VoltexVolume

public VoltexVolume(ij.ImagePlus imp,
                    boolean[] ch)

Initializes this Volume with the specified image and channels.

Parameters:

imp -

ch - A boolean[] array of length three, which indicates whether the red, blue and green channel should be read. This has only an effect when reading color images.

Method Detail

setImage

public void setImage(ij.ImagePlus imp,
                     boolean[] ch)

Overrides:

setImage in class Volume

clear

public void clear()

Overrides:

clear in class Volume

swap

public void swap(String path)

Overrides:

swap in class Volume

restore

public void restore(String path)

Overrides:

restore in class Volume

updateData

public void updateData()

getImageComponentZ

public org.jogamp.java3d.ImageComponent2D getImageComponentZ(int index)

getImageComponentY

public org.jogamp.java3d.ImageComponent2D getImageComponentY(int index)

getImageComponentX

public org.jogamp.java3d.ImageComponent2D getImageComponentX(int index)

setNoCheckNoUpdate

public void setNoCheckNoUpdate(int x,
                               int y,
                               int z,
                               int v)

setSaturatedVolumeRendering

public boolean setSaturatedVolumeRendering(boolean b)

Description copied from class: Volume

If true, saturate the channels of RGB images; the RGB values of each pixels are scaled so that at least one of the values is 255, the alpha value is the average of the original RGB values.

Overrides:

setSaturatedVolumeRendering in class Volume

Returns:

true if the value for 'saturatedVolumeRendering' has changed

setAverage

public boolean setAverage(boolean average)

Description copied from class: Volume

If true, build an average byte from the specified channels (for each pixel).

Overrides:

setAverage in class Volume

Returns:

true if the value for 'average' has changed.

setChannels

public boolean setChannels(boolean[] ch)

Sets the channels which are to be used in this volume rendering. Returns true if the channel settings has changed.

Overrides:

setChannels in class Volume

Returns:

true if the channels settings has changed.

setLUTs

public boolean setLUTs(int[] r,
                       int[] g,
                       int[] b,
                       int[] a)

Set the lookup tables for this volume rendering. Returns true if the data type of the textures has changed.

Overrides:

setLUTs in class Volume

setAlphaLUTFullyOpaque

public boolean setAlphaLUTFullyOpaque()

Set the alpha channel to fully opaque. Returns true if the data type of the textures have changed.

Overrides:

setAlphaLUTFullyOpaque in class Volume

initVoltexLoader

protected void initVoltexLoader()

Init the loader, based on the currently set data type, which is either INT_DATA or BYTE_DATA.

powerOfTwo

protected static int powerOfTwo(int value)

Calculate the next power of two to the given value.

Parameters:

value -

Returns: