ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkVolume16Reader Class Reference

vtkVolume16Reader - read 16 bit image files More...

Inheritance diagram for Kitware.VTK.vtkVolume16Reader:
[legend]
Collaboration diagram for Kitware.VTK.vtkVolume16Reader:
[legend]

List of all members.

Public Member Functions

 vtkVolume16Reader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkVolume16Reader ()
 Construct object with NULL file prefix; file pattern "s.d"; image range set to (1,1); data origin (0,0,0); data spacing (1,1,1); no data mask; header size 0; and byte swapping turned off.
int GetDataByteOrder ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.
string GetDataByteOrderAsString ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.
virtual int[] GetDataDimensions ()
 Specify the dimensions for the data.
virtual void GetDataDimensions (IntPtr data)
 Specify the dimensions for the data.
virtual ushort GetDataMask ()
 Specify a mask used to eliminate data in the data file (e.g., connectivity bits).
virtual int GetHeaderSize ()
 Specify the number of bytes to seek over at start of image.
override vtkImageData GetImage (int ImageNumber)
 Other objects make use of these methods.
virtual int GetSwapBytes ()
 Turn on/off byte swapping.
virtual vtkTransform GetTransform ()
 Set/Get transformation matrix to transform the data from slice space into world space. This matrix must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.
override int IsA (string type)
 Undocumented Block.
new vtkVolume16Reader NewInstance ()
 Undocumented Block.
void SetDataByteOrder (int arg0)
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.
void SetDataByteOrderToBigEndian ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.
void SetDataByteOrderToLittleEndian ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.
virtual void SetDataDimensions (int _arg1, int _arg2)
 Specify the dimensions for the data.
void SetDataDimensions (IntPtr _arg)
 Specify the dimensions for the data.
virtual void SetDataMask (ushort _arg)
 Specify a mask used to eliminate data in the data file (e.g., connectivity bits).
virtual void SetHeaderSize (int _arg)
 Specify the number of bytes to seek over at start of image.
virtual void SetSwapBytes (int _arg)
 Turn on/off byte swapping.
virtual void SetTransform (vtkTransform arg0)
 Set/Get transformation matrix to transform the data from slice space into world space. This matrix must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.
virtual void SwapBytesOff ()
 Turn on/off byte swapping.
virtual void SwapBytesOn ()
 Turn on/off byte swapping.

Static Public Member Functions

static new vtkVolume16Reader New ()
 Construct object with NULL file prefix; file pattern "s.d"; image range set to (1,1); data origin (0,0,0); data spacing (1,1,1); no data mask; header size 0; and byte swapping turned off.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkVolume16Reader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkVolume16Reader"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkVolume16Reader"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkVolume16Reader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkVolume16Reader_GetDataByteOrder_01 (HandleRef pThis)
static internal IntPtr vtkVolume16Reader_GetDataByteOrderAsString_02 (HandleRef pThis)
static internal IntPtr vtkVolume16Reader_GetDataDimensions_03 (HandleRef pThis)
static internal void vtkVolume16Reader_GetDataDimensions_04 (HandleRef pThis, IntPtr data)
static internal ushort vtkVolume16Reader_GetDataMask_05 (HandleRef pThis)
static internal int vtkVolume16Reader_GetHeaderSize_06 (HandleRef pThis)
static internal IntPtr vtkVolume16Reader_GetImage_07 (HandleRef pThis, int ImageNumber, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkVolume16Reader_GetSwapBytes_08 (HandleRef pThis)
static internal IntPtr vtkVolume16Reader_GetTransform_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkVolume16Reader_IsA_10 (HandleRef pThis, string type)
static internal int vtkVolume16Reader_IsTypeOf_11 (string type)
static internal IntPtr vtkVolume16Reader_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkVolume16Reader_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVolume16Reader_SetDataByteOrder_15 (HandleRef pThis, int arg0)
static internal void vtkVolume16Reader_SetDataByteOrderToBigEndian_16 (HandleRef pThis)
static internal void vtkVolume16Reader_SetDataByteOrderToLittleEndian_17 (HandleRef pThis)
static internal void vtkVolume16Reader_SetDataDimensions_18 (HandleRef pThis, int _arg1, int _arg2)
static internal void vtkVolume16Reader_SetDataDimensions_19 (HandleRef pThis, IntPtr _arg)
static internal void vtkVolume16Reader_SetDataMask_20 (HandleRef pThis, ushort _arg)
static internal void vtkVolume16Reader_SetHeaderSize_21 (HandleRef pThis, int _arg)
static internal void vtkVolume16Reader_SetSwapBytes_22 (HandleRef pThis, int _arg)
static internal void vtkVolume16Reader_SetTransform_23 (HandleRef pThis, HandleRef arg0)
static internal void vtkVolume16Reader_SwapBytesOff_24 (HandleRef pThis)
static internal void vtkVolume16Reader_SwapBytesOn_25 (HandleRef pThis)

Static Private Member Functions

static vtkVolume16Reader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkVolume16Reader - read 16 bit image files

Description vtkVolume16Reader is a source object that reads 16 bit image files.

Volume16Reader creates structured point datasets. The dimension of the dataset depends upon the number of files read. Reading a single file results in a 2D image, while reading more than one file results in a 3D volume.

File names are created using FilePattern and FilePrefix as follows: sprintf (filename, FilePattern, FilePrefix, number); where number is in the range ImageRange[0] to ImageRange[1]. If ImageRange[1] <= ImageRange[0], then slice number ImageRange[0] is read. Thus to read an image set ImageRange[0] = ImageRange[1] = slice number. The default behavior is to read a single file (i.e., image slice 1).

The DataMask instance variable is used to read data files with imbedded connectivity or segmentation information. For example, some data has the high order bit set to indicate connected surface. The DataMask allows you to select this data. Other important ivars include HeaderSize, which allows you to skip over initial info, and SwapBytes, which turns on/off byte swapping.

The Transform instance variable specifies a permutation transformation to map slice space into world space. vtkImageReader has replaced the functionality of this class and should be used instead.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Construct object with NULL file prefix; file pattern "s.d"; image range set to (1,1); data origin (0,0,0); data spacing (1,1,1); no data mask; header size 0; and byte swapping turned off.


Member Function Documentation

override void Kitware.VTK.vtkVolume16Reader.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkVolumeReader.

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

Specify the dimensions for the data.

virtual void Kitware.VTK.vtkVolume16Reader.GetDataDimensions ( IntPtr  data) [virtual]

Specify the dimensions for the data.

virtual ushort Kitware.VTK.vtkVolume16Reader.GetDataMask ( ) [virtual]

Specify a mask used to eliminate data in the data file (e.g., connectivity bits).

Specify the number of bytes to seek over at start of image.

override vtkImageData Kitware.VTK.vtkVolume16Reader.GetImage ( int  ImageNumber) [virtual]

Other objects make use of these methods.

Reimplemented from Kitware.VTK.vtkVolumeReader.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkVolume16Reader.GetSwapBytes ( ) [virtual]

Turn on/off byte swapping.

Set/Get transformation matrix to transform the data from slice space into world space. This matrix must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.

Here is the call graph for this function:

override int Kitware.VTK.vtkVolume16Reader.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeReader.

static new int Kitware.VTK.vtkVolume16Reader.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeReader.

Construct object with NULL file prefix; file pattern "s.d"; image range set to (1,1); data origin (0,0,0); data spacing (1,1,1); no data mask; header size 0; and byte swapping turned off.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeReader.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeReader.

Here is the call graph for this function:

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

virtual void Kitware.VTK.vtkVolume16Reader.SetDataDimensions ( int  _arg1,
int  _arg2 
) [virtual]

Specify the dimensions for the data.

Specify the dimensions for the data.

virtual void Kitware.VTK.vtkVolume16Reader.SetDataMask ( ushort  _arg) [virtual]

Specify a mask used to eliminate data in the data file (e.g., connectivity bits).

virtual void Kitware.VTK.vtkVolume16Reader.SetHeaderSize ( int  _arg) [virtual]

Specify the number of bytes to seek over at start of image.

virtual void Kitware.VTK.vtkVolume16Reader.SetSwapBytes ( int  _arg) [virtual]

Turn on/off byte swapping.

virtual void Kitware.VTK.vtkVolume16Reader.SetTransform ( vtkTransform  arg0) [virtual]

Set/Get transformation matrix to transform the data from slice space into world space. This matrix must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.

virtual void Kitware.VTK.vtkVolume16Reader.SwapBytesOff ( ) [virtual]

Turn on/off byte swapping.

virtual void Kitware.VTK.vtkVolume16Reader.SwapBytesOn ( ) [virtual]

Turn on/off byte swapping.

static internal int Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetDataByteOrder_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetDataByteOrderAsString_02 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetDataDimensions_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetDataDimensions_04 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal ushort Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetDataMask_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetHeaderSize_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetImage_07 ( HandleRef  pThis,
int  ImageNumber,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetSwapBytes_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_GetTransform_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetDataByteOrder_15 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetDataByteOrderToBigEndian_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetDataByteOrderToLittleEndian_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetDataDimensions_18 ( HandleRef  pThis,
int  _arg1,
int  _arg2 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetDataDimensions_19 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetDataMask_20 ( HandleRef  pThis,
ushort  _arg 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetHeaderSize_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetSwapBytes_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SetTransform_23 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SwapBytesOff_24 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolume16Reader.vtkVolume16Reader_SwapBytesOn_25 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkVolume16Reader.MRClassNameKey = "17vtkVolume16Reader" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkVolumeReader.

new const string Kitware.VTK.vtkVolume16Reader.MRFullTypeName = "Kitware.VTK.vtkVolume16Reader"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkVolumeReader.


The documentation for this class was generated from the following file: