com.openinventor.ldm.nodes

Class SoLDMResourceParameters

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.ldm.nodes.SoLDMResourceParameters

All Implemented Interfaces:

SafeDisposable

public class SoLDMResourceParameters
extends SoFieldContainer

Describes resource parameters constraints for a specific LDM data set. This class contains fields and functions for setting resource parameters for one specific SoDataset.

Global LDM parameters can be set using static methods in class SoLDMGlobalResourceParameters. See the SoLDMGlobalResourceParameters class description for an overview of LDM memory management.

See also:

SoDataSet, SoVolumeData, SoLDMGlobalResourceParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoLDMResourceParameters.FixedResolutionReport This structure returns information to the application when using fixed resolution mode.
static class	SoLDMResourceParameters.LoadPolicies Tile Load Policy.
static class	SoLDMResourceParameters.TileCachePolicies Tile cache management policy (see the Memory Management section above for more information).

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	fixedResolution Fixed resolution mode.
SoSFInt32	loadNotificationRate Tile loading notification rate.
SoSFEnum<SoLDMResourceParameters.LoadPolicies>	loadPolicy Tile loading policy.
SoSFInt32	max2DTexMemory Maximum of 2D textures memory in MB for this data set.
SoSFInt32	maxMainMemory Maximum allowed main memory in MB that LDM is allowed to use for this data set.
SoSFInt32	maxResolutionThreshold Maximum loading threshold for the LDM module.
SoSFInt32	maxTexMemory Maximum allowed texture (GPU) memory in MB for this data set.
SoSFInt32	minResolutionThreshold Minimum loading threshold for LDM module.
SoSFInt32	numPrefetchThread Number of threads used by the tile prefetch mechanism.
SoSFInt32	resolution Resolution level for fixed resolution mode.
SoSFVec3i32	subTileDimension Size of subtiles used by some accelerated algorithms.
SoSFInt32	tex2LoadRate Maximum number of 2D tiles to be loaded in texture memory per frame.
SoSFInt32	tex3LoadRate Maximum number of 3D tiles to be loaded into texture memory per frame for this data set.
SoSFEnum<SoLDMResourceParameters.TileCachePolicies>	tileCachePolicy Specify which tiles should be cached in LDM memory.
SoSFVec3i32	tileDimension Sets the tile size for non-LDM data.
SoSFFloat	tileHalfLife Tile half-life (seconds).

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoLDMResourceParameters() Constructor.

Method Summary

Modifier and Type	Method and Description
int	getDataSize() Gets the size of a voxel in bytes.
float	getGeometryPriority(java.lang.Class<? extends Inventor> geometryType) Returns the priority of the specified geometry type.
float	getMovingTimeOut() Returns the amount of time during which LDM continues not loading data once a user stops interaction.
void	setGeometryPriority(java.lang.Class<? extends Inventor> geometryType, float priority) Sets the importance of one type of geometry relative to others.
void	setMovingTimeOut(float timeout) Sets the amount of time (in seconds) during which LDM continues not loading once a user stops interaction.

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Field Detail

maxMainMemory

public final SoSFInt32 maxMainMemory

Maximum allowed main memory in MB that LDM is allowed to use for this data set. Default value is -1, meaning LDM is in charge of the automatic sharing of a given resource. Automatic sharing means LDM will compute, by itself, the amount of associated resource it allocates to each dataset. The automatic allocation take in account all nodes in scenegraph.

If value is not -1 (default) LDM will not consider this node in memory allocation, and allocated CPU memory for this node will be the exact value set in the field. In this case, the amount of memory is removed from Global value. All other dataset will share (SoLDMGlobalResourceParameters.getMaxMainMemory - ( Sum of memory of all datasets with maxMainMemory != -1 )) / ( number of datasets with maxMainMemory == -1 )

maxTexMemory

public final SoSFInt32 maxTexMemory

Maximum allowed texture (GPU) memory in MB for this data set. This field is only considered for SoVolumeRender nodes.

Default value is -1, meaning LDM is in charge of the automatic sharing of a given resource. Automatic sharing means LDM will compute, by itself, the amount of associated resource it allocates to each dataset. The automatic allocation take in account all nodes in scenegraph.

If value is not -1 (default) LDM will not consider this node in memory allocation, and allocated CPU memory for this node will be the exact value set in the field. In this case, the amount of memory is removed from Global value. All other dataset will share (SoLDMGlobalResourceParameters.getMaxTexMemory - ( Sum of memory of all datasets with maxTexMemory != -1 )) / ( number of datasets with maxTexMemory == -1 )

loadPolicy

public final SoSFEnum<SoLDMResourceParameters.LoadPolicies> loadPolicy

Tile loading policy. . Default is NO_USER_INTERACTION. NO_USER_INTERACTION means the asynchronous loading threads will only load tiles when the user is not interacting with the scene (i.e. the application is idle).

The loading occurs as long as there is something to load if ALWAYS is passed. No loading occurs if NEVER is passed, however at least the resolution 0 is loaded.

tileCachePolicy

public final SoSFEnum<SoLDMResourceParameters.TileCachePolicies> tileCachePolicy

Specify which tiles should be cached in LDM memory. Please refer to TileCachePolicy for the different options. Default value is ALL.

Note that in the case of an in-memory volume, the default mode will duplicate data in memory. In this case, you should use LOWRES_ONLY or NONE.

Since:

Open Inventor 10.0

tex3LoadRate

public final SoSFInt32 tex3LoadRate

Maximum number of 3D tiles to be loaded into texture memory per frame for this data set. You can set this number for all data sets by calling SoLDMGlobalResourceParameters.setTex3LoadRate(). This field is only considered for SoVolumeRender nodes.

Each tile needed for volume rendering (SoVolumeRender) and volume geometry must be transfered to GPU memory as a 3D texture. So, for example, transfering 1000 tiles at the loadRate 10 requires 100 frames. (How many seconds this takes depends on the frames per second possible, which in turn depends on many factors including the complexity of the scene graph.) Increasing the loadRate value reduces the number of frames required to reach maximum resolution. But the render traversal has to wait for the data transfer to finish, so each frame may take longer to render, increasing the total time to reach maximum resolution.

Default value is -1, meaning LDM is in charge of the automatic sharing of a given resource. Automatic sharing means LDM will compute, by itself, the amount of associated resource it allocates to each dataset. The automatic allocation takes into account all nodes in scenegraph.

If value is not -1 (default) LDM will not consider this node in automatic allocation, and allocated 3D texture LoadRate for this node will be the exact value set in the field. In this case, the amount of memory is removed from Global value. All other dataset will share (SoLDMGlobalResourceParameters.getTex3LoadRate - ( Sum of memory of all datasets with tex3LoadRate != -1 )) / ( number of datasets with tex3LoadRate == -1 )

max2DTexMemory

public final SoSFInt32 max2DTexMemory

Maximum of 2D textures memory in MB for this data set. This field is only considered for SoSlice nodes.

Each tile needed to render a slice (SoOrthoSlice, SoVolumeSkin, etc) must be stored in GPU memory as a 2D texture. This method limits the amount of GPU memory that can be used by (for example) SoOrthoSlice and SoVolumeSkin nodes. This can be useful when combining slices and volume rendering because the 3D textures used by volume rendering require much more GPU memory.

Default value is -1, meaning LDM is in charge of the automatic sharing of a given resource. Automatic sharing means LDM will compute, by itself, the amount of associated resource it allocates to each dataset. The automatic allocation takes into account all nodes in scenegraph.

If value is not -1 (default) LDM will not consider this node in memory allocation, and allocated CPU memory for this node will be the exact value set in the field. In this case, the amount of memory is removed from Global value. All other dataset will share (SoLDMGlobalResourceParameters.setMax2DTexMemory - ( Sum of memory of all datasets with max2DTexMemory != -1 )) / ( number of datasets with max2DTexMemory == -1 )

Since:

Open Inventor 9.6.0

tex2LoadRate

public final SoSFInt32 tex2LoadRate

Maximum number of 2D tiles to be loaded in texture memory per frame. This affects rendering nodes that use 2D textures, for example SoOrthoSlice and SoVolumeSkin. Default is SoLDMGlobalResourceParameters.getTex2LoadRate(). This field is only considered for SoSlice nodes.

Each tile needed to render a slice (SoOrthoSlice, SoVolumeSkin, etc) must be loaded into GPU memory as a 2D texture. Increasing the loadRate value reduces the number of frames required to reach maximum resolution. But the render traversal has to wait for the data transfer to finish, so each frame may take longer to render, increasing the total time to reach maximum resolution.

Default value is -1, meaning LDM is in charge of the automatic sharing of a given resource. Automatic sharing means LDM will compute, by itself, the amount of associated resource it allocates to each dataset. The automatic allocation takes into account all nodes in scenegraph.

If value is not -1 (default) LDM will not consider this node in automatic allocation, and allocated 2D texture for this node will be the exact value set in the field. In this case, the amount of LoadRate is removed from Global value. All other dataset will share (SoLDMGlobalResourceParameters.getTex2LoadRate - ( Sum of memory of all datasets with tex2LoadRate != -1 )) / ( number of datasets with tex2LoadRate == -1 )

minResolutionThreshold

public final SoSFInt32 minResolutionThreshold

Minimum loading threshold for LDM module. Specifies to LDM to never unload tiles below this resolution threshold. Threshold is the power of 2 of the desired subsample level. For instance, passing 2 means never unload tiles of resolution 1/4. Default is -1, meaning the minimum subsample level.

If used with an ROI enabled, only tiles below the min resolution threshold and within the ROI subvolume will never be unloaded. All tiles outside the ROI subvolume will be unloaded. The ROI box allows you to specify where it is the most important to increase the resolution within the subvolume. By default, (subvolume ROI flag enabled) this would be within the box. If for example using the exclusion box mode, then lower resolution tiles will be within the box and higher resolution ones outside the box and within the subvolume.

maxResolutionThreshold

public final SoSFInt32 maxResolutionThreshold

Maximum loading threshold for the LDM module. LDM will never load tiles below this resolution threshold. Threshold is the power of 2 of the desired subsample level. For instance, passing 1 means never load tiles of full resolution. Default is 0, full resolution, i.e., load everything.

tileDimension

public final SoSFVec3i32 tileDimension

Sets the tile size for non-LDM data. VolumeViz always manages volume data in CPU memory as a hierarchy of tiles and data is transferred to GPU memory as tiles. When using VolumeViz with in-memory data or a file format other than LDM, the data is converted to tiles "on the fly". In this case, it is possible to use this field to specify the tile size and this may affect performance.

When loading data using an LDM volume reader, e.g. loading an LDM format file or using a custom volume reader that implements the readTile() method, the tile size is the value returned by the reader's getTileSize() method and cannot be modified by the application, so this field is ignored.

The default tile size is (128, 128, 128). Specifying a larger tile size than the default can improve performance and reduce the time required to fully refine the image. For example, a larger tile size reduces the total number of tiles that must be managed. However there are some trade-offs and limitations. A larger tile size means that the volume reader must load more data from the disk for each tile requested. That makes a larger tile size potentially more efficient for volume rendering, but means it will take longer to load the data to render a single slice because most of the data in each tile is not relevant for rendering that slice (but see also SoSlice.largeSliceSupport). In general we recommend setting the tile size to 128 or 256. For relatively small volumes, especially in-memory volumes 512^3 or less, it can be effective to set the tile size equal to the volume size. This allows the entire volume to be handled as a single tile.

Notes:

• Tile dimension values must be a power-of-2, e.g. 64, 128, 256, etc.
• Maximum tile dimension is 1024.
• tileDimension[1] should be equal to tileDimension[0].
  If this is not the case a warning message will be generated and LDM will use tileDimension[0] for both the I and J tile dimensions. tileDimension[2] may be smaller than the other two values, for example if the volume's K dimension is smaller than the I and J tile dimension. tileDimension[2] will be exactly 1 for a 2D image.
• tileDimension must be set after setting the volume filename or volume reader on an SoVolumeData node.
• Tiles are stored as textures on the GPU. Therefore a tile must not exceed the maximum size allowed by the GPU. This value depends on the GPU, but currently tile dimension should not be larger than 2048 or 4096.
• If the tile dimension is set larger than the default value and the 'subdivideTile' field is set to true in the SoVolumeRender node, then the subtileDimension should also be set to a larger value to avoid reducing performance. In general we recommend setting subTileDimension to tileDimension/4

subTileDimension

public final SoSFVec3i32 subTileDimension

Size of subtiles used by some accelerated algorithms. Default is (32, 32, 32). This field is only considered for SoVolumeRender nodes when field #subdivideTile is set to true. Notes:

• The subTileDimension values must be a power-of-2, e.g. 32, 64, 128, etc.
• It takes time to build subtiles, in general we recommend setting subTileDimension to tileDimension/4.
• The default subTileDimension (32) is appropriate for the default tileDimension (128), but should be set to a larger value if the tileDimension is a larger value. Using too small a value will reduce performance.

loadNotificationRate

public final SoSFInt32 loadNotificationRate

Tile loading notification rate. Default is 50 tiles. When rate tiles have been loaded in main memory, a redraw will be scheduled. Which means, for the default rate, that if each voxel is one byte and the tile size is 64x64x64, a redraw will be scheduled whenever 13 MB of data has been loaded.

Default value is -1, meaning LDM is in charge of the automatic sharing of a given resource. Automatic sharing means LDM will compute, by itself, the amount of associated resource it allocates to each dataset. The automatic allocation takes into account all nodes in scenegraph.

If value is not -1 (default) LDM will not consider this node in automatic allocation, and allocated Notification rate for this node will be the exact value set in the field. In this case, the fixed value of notification rate is then removed from Global value. All other dataset will share (SoLDMGlobalResourceParameters.getLoadNotificationRate - ( Sum of memory of all datasets with * loadNotificationRate != -1 )) / ( number of datasets with loadNotificationRate == -1 )

tileHalfLife

public final SoSFFloat tileHalfLife

Tile half-life (seconds). Default is 2 seconds. When calling SoDataSet.getLdmDataAccess.getData(), once a tile is unlocked by the application (call to SoDataSet.getLdmDataAccess.releaseData), its weight will decrease until the tile is weighted again by LDM. This function allows you to set how long it takes for the tile's weight to be divided by 2 (initial weight is 1). The tile weight will be set to 0 when the weight becomes less than 0.05.

fixedResolution

public final SoSFBool fixedResolution

Fixed resolution mode. Default is false. This mode allows you to request that LDM render using tiles at the specified resolution level (see resolution field). If the requested resolution requires more memory than currently allowed (see maxMainMemory, maxTexMemory and SoLDMGlobalResourceParameters) the highest resolution that fits in memory will be used. Note that tiles at lower resolution levels are always loaded into memory, but tiles at higher resolution levels (if any) will not be loaded.

resolution

public final SoSFInt32 resolution

Resolution level for fixed resolution mode. Default is 1, i.e., 1 out of 2 voxels resolution. The requested resolution is specified as the power of 2 of the desired subsample level. Resolution level 0 is full resolution data. If requested resolution requires more memory than allowed (see maxMainMemory, maxTexMemory, SoLDMGlobalResourceParameters) the highest resolution that fits is used.

numPrefetchThread

public final SoSFInt32 numPrefetchThread

Number of threads used by the tile prefetch mechanism. Tile prefetch is activated when LDM_USE_PREFETCH_OPTIM and LDM_USE_IN_MEM_COMPRESSION are set to true. Default value is -1, meaning the maximum number of threads will be used.

Constructor Detail

SoLDMResourceParameters

public SoLDMResourceParameters()

Constructor.

Method Detail

setGeometryPriority

public void setGeometryPriority(java.lang.Class<? extends Inventor> geometryType,
                                float priority)

Sets the importance of one type of geometry relative to others. The geometry type should be one of the VolumeViz geometry classes. For example, SoOrthoSlice.getClassTypeId().

The priority passed must be between 0 and 1, 0 being lowest priority and 1 the highest. LDM will refine tiles first where geometries are the most important. For example, if an SoVolumeRender node has a higher priority than slices, then the tiles required for this SoVolumeRender node will be refined first.

Default is 0.5 for a volume, 0.9 for other geometry.

getDataSize

public int getDataSize()

Gets the size of a voxel in bytes.

getGeometryPriority

public float getGeometryPriority(java.lang.Class<? extends Inventor> geometryType)

Returns the priority of the specified geometry type. The function will return false if the geometry is of unknown type. See setGeometryPriority().

setMovingTimeOut

public void setMovingTimeOut(float timeout)

Sets the amount of time (in seconds) during which LDM continues not loading once a user stops interaction. In other words, LDM will start loading again timeOut seconds after the user stops interaction. Considered only in NO_USER_INTERACTION mode. Default is 0.3 seconds.

getMovingTimeOut

public float getMovingTimeOut()

Returns the amount of time during which LDM continues not loading data once a user stops interaction. Considered only in NO_USER_INTERACTION mode. See setMovingTimeOut().