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. SeeSoImageDataAdapter
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. OnlySoMemoryDataAdapter
is guaranteed to do that. As a result, only anSoMemoryDataAdapter
(or anSoProxyDataAdapter
that is attached to anSoMemoryDataAdapter
) is completely safe to use as input for ImageViz filter engines. Many engines will work with data partially in memory, but some, for exampleSoImageRegistrationTransform
, 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 anSoMemoryDataAdapter
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 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 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
extent, interpretation, orientation
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor 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, getName, isDisposable, isSynchronizable, setName, setSynchronizable, touch
-
Methods inherited from class com.openinventor.inventor.Inventor
getNativeResourceHandle
-
-
-
-
Field Detail
-
fileName
public final SoSFFilePathString fileName
Data filename to get data from. SeeSbImageDataAdapterHelper.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 anSoMemoryDataAdapter
.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. SeeSbImageDataAdapterHelper.getAppropriateAdapter()
for more details.
-
-