Package com.openinventor.ldm.nodes

Enum Class SoLDMResourceParameters.TileCachePolicies

java.lang.Object
java.lang.Enum<SoLDMResourceParameters.TileCachePolicies>
com.openinventor.ldm.nodes.SoLDMResourceParameters.TileCachePolicies
All Implemented Interfaces:
IntegerValuedEnum, Serializable, Comparable<SoLDMResourceParameters.TileCachePolicies>, Constable
Enclosing class:
SoLDMResourceParameters
public static enum SoLDMResourceParameters.TileCachePolicies extends Enum<SoLDMResourceParameters.TileCachePolicies> implements IntegerValuedEnum
Tile cache management policy. This enum is used by the field tileCachePolicy.

It specifies when and how the tiles are stored in CPU memory.

For non-compressed tiled data, the cache policy has no effect. The tiles are stored as-is in the first level CPU cache during data loading.

See SoLDMGlobalResourceParameters for detail on the first and second level CPU tile cache.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL
    For non-tiled data such as DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU) and both low resolution and full resolution tiles are stored in the first level CPU tile cache.
    LOWRES_ONLY
    For non-tiled data such as DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU): full resolution tiles are stored in the second level CPU tile cache and all the other created tiles (lower resolution) are stored in the first level CPU tile cache.
    NONE
    For non-tiled data such as DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU) and stored in the second level CPU tile cache.

  • Method Summary

    Modifier and Type
    Method
    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(String name)
    Returns the enum constant of this class with the specified name.
    static SoLDMResourceParameters.TileCachePolicies[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final SoLDMResourceParameters.TileCachePolicies NONE
      For non-tiled data such as DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU) and stored in the second level CPU tile cache. For tiled data that is compressed (e.g. an LDM file created with compression), the compressed tiles are stored in the first level CPU tile cache "as is" to reduce the memory footprint (the first level tile cache contains only compressed data). When a tile must be sent to the GPU, it is uncompressed and the resulting uncompressed tile is stored in the second level CPU tile cache.

      This mode saves memory but can reduce interactivity.

    • LOWRES_ONLY

      public static final SoLDMResourceParameters.TileCachePolicies LOWRES_ONLY
      For non-tiled data such as DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU): full resolution tiles are stored in the second level CPU tile cache and all the other created tiles (lower resolution) are stored in the first level CPU tile cache. For tiled data that is compressed (e.g. an LDM file created with compression), the full resolution tiles are stored *compressed* in the first level CPU tile cache (to reduce the CPU memory footprint) and the other created tiles are stored *uncompressed* in the first level CPU tile cache. When compressed tiles must be sent to the GPU, they are uncompressed and stored in the second level CPU tile 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 such as DICOM or SEGY or in-memory volume, tiles are created when needed (to send data to the GPU) and both low resolution and full resolution tiles are stored in the first level 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 is better to use the LOWRES_ONLY or NONE setting.

      For tiled data that is compressed (e.g. an LDM file created with compression), both full resolution and low resolution tiles are uncompressed when loaded and stored *uncompressed* in the first level CPU tile cache.

      This setting uses the most memory, but saves time when tiles need to be sent to the GPU. It does not use the second level CPU tile cache.

  • Method Details

    • values

      public static SoLDMResourceParameters.TileCachePolicies[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SoLDMResourceParameters.TileCachePolicies valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      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.