com.openinventor.ldm.nodes

Enum SoLDMResourceParameters.TileCachePolicies

java.lang.Object

java.lang.Enum<SoLDMResourceParameters.TileCachePolicies>

com.openinventor.ldm.nodes.SoLDMResourceParameters.TileCachePolicies

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoLDMResourceParameters.TileCachePolicies>

Enclosing class:

SoLDMResourceParameters

public static enum SoLDMResourceParameters.TileCachePolicies
extends java.lang.Enum<SoLDMResourceParameters.TileCachePolicies>
implements IntegerValuedEnum

Tile cache management policy (see the Memory Management section above for more information). Used with #setTileCacheType() method.

For tiled data that is not compressed (e.g. a standard LDM format file), the TileCacheType setting has no effect and only the CPU tile cache is used.

Setting the SoPreferences variable LDM_USE_IN_MEM_COMPRESSION to false (zero) effectively sets the tile cache type to mode ALL.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL For non-tiled data like DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU) and all tiles (both low resolution and full resolution) are stored in the CPU tile cache.
LOWRES_ONLY For non-tiled data like DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU), but low resolution tiles are stored in the CPU tile cache and full resolution tiles are stored in the BufferObject cache.
NONE For non-tiled data like DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU) and all tiles (both low resolution and full resolution) are stored in the BufferObject cache.

Method Summary

Modifier and Type	Method and Description
int	getValue() Returns the integer value of the enum constant.
static SoLDMResourceParameters.TileCachePolicies	valueOf(int val) Returns the enum constant of this type with the specified integer value
static SoLDMResourceParameters.TileCachePolicies	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SoLDMResourceParameters.TileCachePolicies[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SoLDMResourceParameters.TileCachePolicies NONE

For non-tiled data like DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU) and all tiles (both low resolution and full resolution) are stored in the BufferObject cache. The CPU tile cache is not used. If the entire volume fits in GPU memory, then tiles will only be created once, otherwise performance is affected because some time is required when tiles need to be re-created and are not in the BufferObject cache.

For tiled data that is compressed (e.g. an LDM file created with compression), the compressed tiles are stored in the CPU tile cache "as is" to reduce the memory requirement. Uncompressed tiles are created from the compressed data when needed (to send data to the GPU) and are stored in the BufferObject cache.

This mode saves memory but can reduce interactivity.

LOWRES_ONLY

public static final SoLDMResourceParameters.TileCachePolicies LOWRES_ONLY

For non-tiled data like DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU), but low resolution tiles are stored in the CPU tile cache and full resolution tiles are stored in the BufferObject cache. For tiled data that is compressed (e.g. an LDM file created with compression), low resolution tiles are uncompressed when loaded and stored uncompressed in the CPU tile cache. Full resolution tiles are stored compressed in the CPU tile cache (to reduce the CPU memory requirement). Uncompressed tiles are created from the compressed data when needed (to send data to the GPU) and are stored in the BufferObject cache.

This setting uses more memory but saves time when low resolution tiles need to be sent to the GPU.

ALL

public static final SoLDMResourceParameters.TileCachePolicies ALL

For non-tiled data like DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU) and all tiles (both low resolution and full resolution) are stored in the CPU tile cache. This mode is recommended for non-tiled volumes loaded from disk when the volume will fit in memory (generally true for medical volumes).
NOTE: For an in-memory volume, this setting will duplicate the data in memory. For an in-memory volume it?s better to use the FULLRES_ONLY or NONE setting.

For tiled data that is compressed (e.g. an LDM file created with compression), all tiles are uncompressed when loaded and stored uncompressed in the CPU tile cache.

This setting uses the most memory, but saves time when tiles need to be sent to the GPU. The BufferObject cache is not used.

Method Detail

values

public static SoLDMResourceParameters.TileCachePolicies[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SoLDMResourceParameters.TileCachePolicies c : SoLDMResourceParameters.TileCachePolicies.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SoLDMResourceParameters.TileCachePolicies valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

valueOf

public static SoLDMResourceParameters.TileCachePolicies valueOf(int val)

Returns the enum constant of this type with the specified integer value

Returns:

the enum constant of this type with the specified integer value.

getValue

public int getValue()

Description copied from interface: IntegerValuedEnum

Returns the integer value of the enum constant.

Specified by:

getValue in interface IntegerValuedEnum

Returns:

the integer value of the enum constant.