| SoImageDataAdapter Class |
Abstract base class for all ImageViz image data adapter classes.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.ImageViz.Nodes.ImagesSoImageDataAdapter
OIV.ImageViz.Nodes.ImagesSoFileDataAdapter
OIV.ImageViz.Nodes.ImagesSoMemoryDataAdapter
OIV.ImageViz.Nodes.ImagesSoProxyDataAdapter
OIV.ImageViz.Nodes.ImagesSoVolumeReaderAdapter
Namespace: OIV.ImageViz.Nodes.Images
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoImageDataAdapter type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetColumnDirection | Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,1,0). |
| GetDataAccessor | Returns an OIV.ImageViz.SbImageDataAccessor. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetExtent | Returns the extent of the image in 3D. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetImageDataType | Returns the data type of the image. |
| GetIndexToPhysicalTransformation | Returns the transformation that maps a position in the image coordinate system to a position in the physical coordinate system. |
| GetInterpretation | Returns the current interpretation of the image. |
| GetName | Returns the name of an instance. |
| GetOrigin | Returns the image origin in 3D. |
| GetPlaneDirection | Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,0,1). |
| GetRowDirection | Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (1,0,0). |
| GetSize | Returns a vector representing the dimensions of the image data. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVoxelSize | Returns the size of a voxel in 3D. |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetDirection | Set the direction cosines of rows and columns. |
| SetInterpretation | Sets the interpretation of the image. |
| SetName | (Inherited from SoBase.) |
| SetOrigin | Sets the image origin in 3D. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| SetVoxelSize | Sets the voxel size in 3D. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
Properties| Name | Description | |
|---|---|---|
 | extent | The OIV.ImageViz.Nodes.Images.SoImageDataAdapter.extent and OIV.ImageViz.Nodes.Images.SoImageDataAdapter.orientation fields define the position, size and orientation of the image in 3D (typicallly the physical space). |
| interpretation | Image Interpretation Default is OIV.ImageViz.Nodes.Images.SoImageDataAdapter.Interpretations.VALUE. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| orientation | |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksSee for example:
OIV.ImageViz.Nodes.Images.SoFileDataAdapter to use data in a file.
OIV.ImageViz.Nodes.Images.SoMemoryDataAdapter to use data already in memory.
OIV.ImageViz.Nodes.Images.SoProxyDataAdapter to use a subset of data already in an OIV.ImageViz.Nodes.Images.SoImageDataAdapter.
OIV.ImageViz.Nodes.Images.SoVolumeReaderAdapter to use data from an OIV.LDM.Readers.SoVolumeReader.
NOTE:OIV.ImageViz.Nodes.Images.SoImageDataAdapter provides access to the image data but does not guarantee that all the data is loaded in memory. Only OIV.ImageViz.Nodes.Images.SoMemoryDataAdapter is guaranteed to do that. As a result, only an OIV.ImageViz.Nodes.Images.SoMemoryDataAdapter (or an OIV.ImageViz.Nodes.Images.SoProxyDataAdapter that is attached to an OIV.ImageViz.Nodes.Images.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 OIV.ImageViz.Engines.GeometryAndMatching.Registration.SoImageRegistrationTransform, 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 OIV.ImageViz.Nodes.Images.SoMemoryDataAdapter object if there is enough memory to load all the data.
See Also