Click or drag to resize
SoFileDataAdapter Class

Image data adapter for data in a file.

Inheritance Hierarchy

Namespace: OIV.ImageViz.Nodes.Images
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 10.3.0.0 (10.3.0.0)
Syntax
public class SoFileDataAdapter : SoImageDataAdapter

The SoFileDataAdapter type exposes the following members.

Constructors
  NameDescription
Public methodSoFileDataAdapter

Default constructor.

Top
Methods
  NameDescription
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetColumnDirection

Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,1,0).

(Inherited from SoImageDataAdapter.)
Public methodGetDataAccessor (Inherited from SoImageDataAdapter.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetExtent

Returns the extent of the image in 3D.

(Inherited from SoImageDataAdapter.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetImageDataType

Returns the data type of the image.

(Inherited from SoImageDataAdapter.)
Public methodGetIndexToPhysicalTransformation

Returns the transformation that maps a position in the image coordinate system to a position in the physical coordinate system.

(Inherited from SoImageDataAdapter.)
Public methodGetInterpretation

Returns the current interpretation of the image.

(Inherited from SoImageDataAdapter.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetOrigin

Returns the image origin in 3D.

(Inherited from SoImageDataAdapter.)
Public methodGetPlaneDirection

Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,0,1).

(Inherited from SoImageDataAdapter.)
Public methodGetRowDirection

Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (1,0,0).

(Inherited from SoImageDataAdapter.)
Public methodGetSize

Returns a vector representing the dimensions of the image data.

(Inherited from SoImageDataAdapter.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVoxelSize

Returns the size of a voxel in 3D.

(Inherited from SoImageDataAdapter.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetDirection

Set the direction cosines of rows and columns.

(Inherited from SoImageDataAdapter.)
Public methodSetInterpretation

Sets the interpretation of the image.

(Inherited from SoImageDataAdapter.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOrigin

Sets the image origin in 3D.

(Inherited from SoImageDataAdapter.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetVoxelSize

Sets the voxel size in 3D.

(Inherited from SoImageDataAdapter.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Top
Properties
  NameDescription
Public propertyextent

The OIV.ImageViz.Nodes.Images.SoImageDataAdapter.m_extent and OIV.ImageViz.Nodes.Images.SoImageDataAdapter.m_orientation fields define the position, size and orientation of the image in 3D (typicallly the physical space).

(Inherited from SoImageDataAdapter.)
Public propertyfileName

Data filename to get data from.

Public propertyinterpretation (Inherited from SoImageDataAdapter.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymaxMemory

Specifies the maximum memory that may be allocated for the image in MB (megabytes).

Public propertyorientation
(Inherited from SoImageDataAdapter.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

Loads image data from a file. See OIV.ImageViz.Nodes.Images.SoImageDataAdapter for methods to access the data.

NOTE:OIV.ImageViz.Nodes.Images.SoFileDataAdapter 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.

FILE FORMAT/DEFAULT

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

See Also