com.openinventor.imageviz.nodes.images

Class SoFileDataAdapter

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.imageviz.nodes.images.SoImageDataAdapter

com.openinventor.imageviz.nodes.images.SoFileDataAdapter

All Implemented Interfaces:

SafeDisposable

public class SoFileDataAdapter
extends SoImageDataAdapter

Image data adapter for data in a file. Loads image data from a file. See SoImageDataAdapter for methods to access the data.

NOTE:SoFileDataAdapter provides access to the image data but does not guarantee that all the data is loaded in memory. Only SoMemoryDataAdapter is guaranteed to do that. As a result, only an SoMemoryDataAdapter (or an SoProxyDataAdapter that is attached to an SoMemoryDataAdapter) is completely safe to use as input for ImageViz filter engines. Many engines will work with data partially in memory, but some, for example SoImageRegistrationTransform3d, will only work if the image is completely in memory. See the documentation for the specific engines you are using. Conveniently, the utility method SoImageDataAdapterHelper.getAppropriateAdapter() returns an SoMemoryDataAdapter object if there is enough memory to load all the data.

File format/default:

FileDataAdapter {

fileName	""
maxMemory	500
//Inherited
interpretation	VALUE
extent	0,0,0, 1,1,1
orientation	0 0 0 1

}

See also:

SoImageDataAdapter, SoMemoryDataAdapter, SoProxyDataAdapter, SoVolumeReaderAdapter, SoImageDataAdapterHelper

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.imageviz.nodes.images.SoImageDataAdapter

SoImageDataAdapter.Interpretations

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFilePathString	fileName Data filename to get data from.
SoSFUInt32	maxMemory Specifies the maximum memory that may be allocated for the image in MB (megabytes).

Fields inherited from class com.openinventor.imageviz.nodes.images.SoImageDataAdapter

BINARY, extent, interpretation, LABEL, orientation, VALUE

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoFileDataAdapter() Default constructor.

Method Summary

Methods inherited from class com.openinventor.imageviz.nodes.images.SoImageDataAdapter

getColumnDirection, getDataAccessor, getExtent, getImageDataType, getIndexToPhysicalTransformation, getInterpretation, getOrigin, getPlaneDirection, getRowDirection, getSize, getVoxelSize, setDirection, setInterpretation, setOrigin, setVoxelSize

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, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

fileName

public final SoSFFilePathString fileName

Data filename to get data from. See SbImageDataAdapterHelper.getAppropriateAdapter for a detailed description of supported file formats.

maxMemory

public final SoSFUInt32 maxMemory

Specifies the maximum memory that may be allocated for the image in MB (megabytes). If the data can fit in the specified maximum memory, the image will be loaded in memory as an SoMemoryDataAdapter.

Default value is 500 MB. The default value can be overridden by the environment variable IMAGEVIZ_MAX_MEMORY_ADAPTER.

Important note: This field must be set before the fileName field to be taken into account. See SbImageDataAdapterHelper.getAppropriateAdapter() for more details.

Constructor Detail

SoFileDataAdapter

public SoFileDataAdapter()

Default constructor.