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.vtkVolumeReader Class Reference

vtkVolumeReader - read image files More...

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

List of all members.

Public Member Functions

 vtkVolumeReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual double[] GetDataOrigin ()
 Specify the origin for the data.
virtual void GetDataOrigin (IntPtr data)
 Specify the origin for the data.
virtual double[] GetDataSpacing ()
 Specify the spacing for the data.
virtual void GetDataSpacing (IntPtr data)
 Specify the spacing for the data.
virtual string GetFilePattern ()
 The sprintf format used to build filename from FilePrefix and number.
virtual string GetFilePrefix ()
 Specify file prefix for the image file(s).
virtual vtkImageData GetImage (int ImageNumber)
 Other objects make use of this method.
virtual int[] GetImageRange ()
 Set the range of files to read.
virtual void GetImageRange (IntPtr data)
 Set the range of files to read.
override int IsA (string type)
 Undocumented Block.
new vtkVolumeReader NewInstance ()
 Undocumented Block.
virtual void SetDataOrigin (double _arg1, double _arg2, double _arg3)
 Specify the origin for the data.
virtual void SetDataOrigin (IntPtr _arg)
 Specify the origin for the data.
virtual void SetDataSpacing (double _arg1, double _arg2, double _arg3)
 Specify the spacing for the data.
virtual void SetDataSpacing (IntPtr _arg)
 Specify the spacing for the data.
virtual void SetFilePattern (string _arg)
 The sprintf format used to build filename from FilePrefix and number.
virtual void SetFilePrefix (string _arg)
 Specify file prefix for the image file(s).
virtual void SetImageRange (int _arg1, int _arg2)
 Set the range of files to read.
void SetImageRange (IntPtr _arg)
 Set the range of files to read.

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkVolumeReader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkVolumeReader"
 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 vtkVolumeReader_GetDataOrigin_01 (HandleRef pThis)
static internal void vtkVolumeReader_GetDataOrigin_02 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkVolumeReader_GetDataSpacing_03 (HandleRef pThis)
static internal void vtkVolumeReader_GetDataSpacing_04 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkVolumeReader_GetFilePattern_05 (HandleRef pThis)
static internal IntPtr vtkVolumeReader_GetFilePrefix_06 (HandleRef pThis)
static internal IntPtr vtkVolumeReader_GetImage_07 (HandleRef pThis, int ImageNumber, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkVolumeReader_GetImageRange_08 (HandleRef pThis)
static internal void vtkVolumeReader_GetImageRange_09 (HandleRef pThis, IntPtr data)
static internal int vtkVolumeReader_IsA_10 (HandleRef pThis, string type)
static internal int vtkVolumeReader_IsTypeOf_11 (string type)
static internal IntPtr vtkVolumeReader_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkVolumeReader_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVolumeReader_SetDataOrigin_14 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkVolumeReader_SetDataOrigin_15 (HandleRef pThis, IntPtr _arg)
static internal void vtkVolumeReader_SetDataSpacing_16 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkVolumeReader_SetDataSpacing_17 (HandleRef pThis, IntPtr _arg)
static internal void vtkVolumeReader_SetFilePattern_18 (HandleRef pThis, string _arg)
static internal void vtkVolumeReader_SetFilePrefix_19 (HandleRef pThis, string _arg)
static internal void vtkVolumeReader_SetImageRange_20 (HandleRef pThis, int _arg1, int _arg2)
static internal void vtkVolumeReader_SetImageRange_21 (HandleRef pThis, IntPtr _arg)

Static Private Member Functions

static vtkVolumeReader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkVolumeReader - read image files

Description vtkVolumeReader is a source object that reads image files.

VolumeReader 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. Consider using vtkImageReader as a replacement.


Constructor & Destructor Documentation

static Kitware.VTK.vtkVolumeReader.vtkVolumeReader ( ) [static, private]

Automatically generated type registration mechanics.

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

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


Member Function Documentation

override void Kitware.VTK.vtkVolumeReader.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.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

virtual double [] Kitware.VTK.vtkVolumeReader.GetDataOrigin ( ) [virtual]

Specify the origin for the data.

virtual void Kitware.VTK.vtkVolumeReader.GetDataOrigin ( IntPtr  data) [virtual]

Specify the origin for the data.

virtual double [] Kitware.VTK.vtkVolumeReader.GetDataSpacing ( ) [virtual]

Specify the spacing for the data.

virtual void Kitware.VTK.vtkVolumeReader.GetDataSpacing ( IntPtr  data) [virtual]

Specify the spacing for the data.

virtual string Kitware.VTK.vtkVolumeReader.GetFilePattern ( ) [virtual]

The sprintf format used to build filename from FilePrefix and number.

virtual string Kitware.VTK.vtkVolumeReader.GetFilePrefix ( ) [virtual]

Specify file prefix for the image file(s).

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

Other objects make use of this method.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

Here is the call graph for this function:

virtual int [] Kitware.VTK.vtkVolumeReader.GetImageRange ( ) [virtual]

Set the range of files to read.

virtual void Kitware.VTK.vtkVolumeReader.GetImageRange ( IntPtr  data) [virtual]

Set the range of files to read.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkVolumeReader.SetDataOrigin ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Specify the origin for the data.

virtual void Kitware.VTK.vtkVolumeReader.SetDataOrigin ( IntPtr  _arg) [virtual]

Specify the origin for the data.

virtual void Kitware.VTK.vtkVolumeReader.SetDataSpacing ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Specify the spacing for the data.

virtual void Kitware.VTK.vtkVolumeReader.SetDataSpacing ( IntPtr  _arg) [virtual]

Specify the spacing for the data.

virtual void Kitware.VTK.vtkVolumeReader.SetFilePattern ( string  _arg) [virtual]

The sprintf format used to build filename from FilePrefix and number.

virtual void Kitware.VTK.vtkVolumeReader.SetFilePrefix ( string  _arg) [virtual]

Specify file prefix for the image file(s).

virtual void Kitware.VTK.vtkVolumeReader.SetImageRange ( int  _arg1,
int  _arg2 
) [virtual]

Set the range of files to read.

Set the range of files to read.

static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetDataOrigin_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetDataOrigin_02 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetDataSpacing_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetDataSpacing_04 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetFilePattern_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetFilePrefix_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetImage_07 ( HandleRef  pThis,
int  ImageNumber,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetImageRange_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_GetImageRange_09 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkVolumeReader.vtkVolumeReader_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkVolumeReader.vtkVolumeReader_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetDataOrigin_14 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetDataOrigin_15 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetDataSpacing_16 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetDataSpacing_17 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetFilePattern_18 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetFilePrefix_19 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetImageRange_20 ( HandleRef  pThis,
int  _arg1,
int  _arg2 
) [private]
static internal void Kitware.VTK.vtkVolumeReader.vtkVolumeReader_SetImageRange_21 ( HandleRef  pThis,
IntPtr  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkVolumeReader.MRClassNameKey = "15vtkVolumeReader" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Reimplemented in Kitware.VTK.vtkVolume16Reader.


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