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

vtkImageReader2 - Superclass of binary file readers. More...

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

List of all members.

Public Member Functions

 vtkImageReader2 (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImageReader2 ()
 Undocumented Block.
virtual int CanReadFile (string arg0)
 Return non zero if the reader can read the given file name. Should be implemented by all sub-classes of vtkImageReader2. For non zero return values the following values are to be used 1 - I think I can read the file but I cannot prove it 2 - I definitely can read the file 3 - I can read the file and I have validated that I am the correct reader for this file.
virtual void ComputeInternalFileName (int slice)
 Set/Get the internal file name.
virtual void FileLowerLeftOff ()
 Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.
virtual void FileLowerLeftOn ()
 Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.
virtual 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.
virtual 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[] GetDataExtent ()
 Get/Set the extent of the data on disk.
virtual void GetDataExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 Get/Set the extent of the data on disk.
virtual void GetDataExtent (IntPtr _arg)
 Get/Set the extent of the data on disk.
virtual uint[] GetDataIncrements ()
 Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual void GetDataIncrements (IntPtr data)
 Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual double[] GetDataOrigin ()
 Set/Get the origin of the data (location of first pixel in the file).
virtual void GetDataOrigin (ref double _arg1, ref double _arg2, ref double _arg3)
 Set/Get the origin of the data (location of first pixel in the file).
virtual void GetDataOrigin (IntPtr _arg)
 Set/Get the origin of the data (location of first pixel in the file).
virtual int GetDataScalarType ()
 Get the file format. Pixels are this type in the file.
virtual double[] GetDataSpacing ()
 Set/Get the spacing of the data in the file.
virtual void GetDataSpacing (ref double _arg1, ref double _arg2, ref double _arg3)
 Set/Get the spacing of the data in the file.
virtual void GetDataSpacing (IntPtr _arg)
 Set/Get the spacing of the data in the file.
virtual string GetDescriptiveName ()
 Return a descriptive name for the file format that might be useful in a GUI.
int GetFileDimensionality ()
 The number of dimensions stored in a file. This defaults to two.
virtual string GetFileExtensions ()
 Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension.
virtual int GetFileLowerLeft ()
 Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.
virtual string GetFileName ()
 Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.
virtual int GetFileNameSliceOffset ()
 When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)
virtual int GetFileNameSliceSpacing ()
 When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1)
virtual vtkStringArray GetFileNames ()
 Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.
virtual string GetFilePattern ()
 The sprintf-style format string used to build filename from FilePrefix and slice number.
virtual string GetFilePrefix ()
 Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.
uint GetHeaderSize ()
 Get the size of the header computed by this object.
uint GetHeaderSize (uint slice)
 Get the size of the header computed by this object.
virtual string GetInternalFileName ()
 Set/Get the internal file name.
virtual int GetNumberOfScalarComponents ()
 Set/Get the number of scalar components.
virtual int GetSwapBytes ()
 Set/Get the byte swapping to explicitly swap the bytes of a file.
override int IsA (string type)
 Undocumented Block.
new vtkImageReader2 NewInstance ()
 Undocumented Block.
virtual int OpenFile ()
 Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual void SeekFile (int i, int j, int k)
 Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual 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.
virtual 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.
virtual 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 SetDataExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 Get/Set the extent of the data on disk.
virtual void SetDataExtent (IntPtr _arg)
 Get/Set the extent of the data on disk.
virtual void SetDataOrigin (double _arg1, double _arg2, double _arg3)
 Set/Get the origin of the data (location of first pixel in the file).
virtual void SetDataOrigin (IntPtr _arg)
 Set/Get the origin of the data (location of first pixel in the file).
virtual void SetDataScalarType (int type)
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToChar ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToDouble ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToFloat ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToInt ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToShort ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToSignedChar ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToUnsignedChar ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToUnsignedInt ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataScalarTypeToUnsignedShort ()
 Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.
virtual void SetDataSpacing (double _arg1, double _arg2, double _arg3)
 Set/Get the spacing of the data in the file.
virtual void SetDataSpacing (IntPtr _arg)
 Set/Get the spacing of the data in the file.
virtual void SetFileDimensionality (int _arg)
 The number of dimensions stored in a file. This defaults to two.
virtual void SetFileLowerLeft (int _arg)
 Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.
virtual void SetFileName (string arg0)
 Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.
virtual void SetFileNameSliceOffset (int _arg)
 When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)
virtual void SetFileNameSliceSpacing (int _arg)
 When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1)
virtual void SetFileNames (vtkStringArray arg0)
 Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.
virtual void SetFilePattern (string arg0)
 The sprintf-style format string used to build filename from FilePrefix and slice number.
virtual void SetFilePrefix (string arg0)
 Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.
virtual void SetHeaderSize (uint size)
 If there is a tail on the file, you want to explicitly set the header size.
virtual void SetNumberOfScalarComponents (int _arg)
 Set/Get the number of scalar components.
virtual void SetSwapBytes (int _arg)
 Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual void SwapBytesOff ()
 Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual void SwapBytesOn ()
 Set/Get the byte swapping to explicitly swap the bytes of a file.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkImageReader2"
 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 vtkImageReader2_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkImageReader2_CanReadFile_01 (HandleRef pThis, string arg0)
static internal void vtkImageReader2_ComputeInternalFileName_02 (HandleRef pThis, int slice)
static internal void vtkImageReader2_FileLowerLeftOff_03 (HandleRef pThis)
static internal void vtkImageReader2_FileLowerLeftOn_04 (HandleRef pThis)
static internal int vtkImageReader2_GetDataByteOrder_05 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetDataByteOrderAsString_06 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetDataExtent_07 (HandleRef pThis)
static internal void vtkImageReader2_GetDataExtent_08 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
static internal void vtkImageReader2_GetDataExtent_09 (HandleRef pThis, IntPtr _arg)
static internal IntPtr vtkImageReader2_GetDataIncrements_10 (HandleRef pThis)
static internal void vtkImageReader2_GetDataIncrements_11 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkImageReader2_GetDataOrigin_12 (HandleRef pThis)
static internal void vtkImageReader2_GetDataOrigin_13 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkImageReader2_GetDataOrigin_14 (HandleRef pThis, IntPtr _arg)
static internal int vtkImageReader2_GetDataScalarType_15 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetDataSpacing_16 (HandleRef pThis)
static internal void vtkImageReader2_GetDataSpacing_17 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkImageReader2_GetDataSpacing_18 (HandleRef pThis, IntPtr _arg)
static internal IntPtr vtkImageReader2_GetDescriptiveName_19 (HandleRef pThis)
static internal int vtkImageReader2_GetFileDimensionality_20 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetFileExtensions_21 (HandleRef pThis)
static internal int vtkImageReader2_GetFileLowerLeft_22 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetFileName_23 (HandleRef pThis)
static internal int vtkImageReader2_GetFileNameSliceOffset_24 (HandleRef pThis)
static internal int vtkImageReader2_GetFileNameSliceSpacing_25 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetFileNames_26 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkImageReader2_GetFilePattern_27 (HandleRef pThis)
static internal IntPtr vtkImageReader2_GetFilePrefix_28 (HandleRef pThis)
static internal uint vtkImageReader2_GetHeaderSize_29 (HandleRef pThis)
static internal uint vtkImageReader2_GetHeaderSize_30 (HandleRef pThis, uint slice)
static internal IntPtr vtkImageReader2_GetInternalFileName_31 (HandleRef pThis)
static internal int vtkImageReader2_GetNumberOfScalarComponents_32 (HandleRef pThis)
static internal int vtkImageReader2_GetSwapBytes_33 (HandleRef pThis)
static internal int vtkImageReader2_IsA_34 (HandleRef pThis, string type)
static internal int vtkImageReader2_IsTypeOf_35 (string type)
static internal IntPtr vtkImageReader2_NewInstance_37 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkImageReader2_OpenFile_38 (HandleRef pThis)
static internal IntPtr vtkImageReader2_SafeDownCast_39 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageReader2_SeekFile_40 (HandleRef pThis, int i, int j, int k)
static internal void vtkImageReader2_SetDataByteOrder_41 (HandleRef pThis, int arg0)
static internal void vtkImageReader2_SetDataByteOrderToBigEndian_42 (HandleRef pThis)
static internal void vtkImageReader2_SetDataByteOrderToLittleEndian_43 (HandleRef pThis)
static internal void vtkImageReader2_SetDataExtent_44 (HandleRef pThis, int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
static internal void vtkImageReader2_SetDataExtent_45 (HandleRef pThis, IntPtr _arg)
static internal void vtkImageReader2_SetDataOrigin_46 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkImageReader2_SetDataOrigin_47 (HandleRef pThis, IntPtr _arg)
static internal void vtkImageReader2_SetDataScalarType_48 (HandleRef pThis, int type)
static internal void vtkImageReader2_SetDataScalarTypeToChar_49 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToDouble_50 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToFloat_51 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToInt_52 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToShort_53 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToSignedChar_54 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToUnsignedChar_55 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToUnsignedInt_56 (HandleRef pThis)
static internal void vtkImageReader2_SetDataScalarTypeToUnsignedShort_57 (HandleRef pThis)
static internal void vtkImageReader2_SetDataSpacing_58 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkImageReader2_SetDataSpacing_59 (HandleRef pThis, IntPtr _arg)
static internal void vtkImageReader2_SetFileDimensionality_60 (HandleRef pThis, int _arg)
static internal void vtkImageReader2_SetFileLowerLeft_61 (HandleRef pThis, int _arg)
static internal void vtkImageReader2_SetFileName_62 (HandleRef pThis, string arg0)
static internal void vtkImageReader2_SetFileNameSliceOffset_63 (HandleRef pThis, int _arg)
static internal void vtkImageReader2_SetFileNameSliceSpacing_64 (HandleRef pThis, int _arg)
static internal void vtkImageReader2_SetFileNames_65 (HandleRef pThis, HandleRef arg0)
static internal void vtkImageReader2_SetFilePattern_66 (HandleRef pThis, string arg0)
static internal void vtkImageReader2_SetFilePrefix_67 (HandleRef pThis, string arg0)
static internal void vtkImageReader2_SetHeaderSize_68 (HandleRef pThis, uint size)
static internal void vtkImageReader2_SetNumberOfScalarComponents_69 (HandleRef pThis, int _arg)
static internal void vtkImageReader2_SetSwapBytes_70 (HandleRef pThis, int _arg)
static internal void vtkImageReader2_SwapBytesOff_71 (HandleRef pThis)
static internal void vtkImageReader2_SwapBytesOn_72 (HandleRef pThis)

Static Private Member Functions

static vtkImageReader2 ()
 Automatically generated type registration mechanics.

Detailed Description

vtkImageReader2 - Superclass of binary file readers.

Description vtkImageReader2 is the parent class for vtkImageReader. It is a good super class for streaming readers that do not require a mask or transform on the data. vtkImageReader was implemented before vtkImageReader2, vtkImageReader2 is intended to have a simpler interface.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

virtual int Kitware.VTK.vtkImageReader2.CanReadFile ( string  arg0) [virtual]

Return non zero if the reader can read the given file name. Should be implemented by all sub-classes of vtkImageReader2. For non zero return values the following values are to be used 1 - I think I can read the file but I cannot prove it 2 - I definitely can read the file 3 - I can read the file and I have validated that I am the correct reader for this file.

Reimplemented in Kitware.VTK.vtkBMPReader, Kitware.VTK.vtkMetaImageReader, Kitware.VTK.vtkDICOMImageReader, Kitware.VTK.vtkMINCImageReader, Kitware.VTK.vtkGESignaReader, Kitware.VTK.vtkJPEGReader, Kitware.VTK.vtkPNGReader, Kitware.VTK.vtkTIFFReader, Kitware.VTK.vtkSLCReader, Kitware.VTK.vtkPNMReader, and Kitware.VTK.vtkPNrrdReader.

virtual void Kitware.VTK.vtkImageReader2.ComputeInternalFileName ( int  slice) [virtual]

Set/Get the internal file name.

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

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual void Kitware.VTK.vtkImageReader2.FileLowerLeftOn ( ) [virtual]

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

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.

Reimplemented in Kitware.VTK.vtkMetaImageReader.

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 [] Kitware.VTK.vtkImageReader2.GetDataExtent ( ) [virtual]

Get/Set the extent of the data on disk.

virtual void Kitware.VTK.vtkImageReader2.GetDataExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [virtual]

Get/Set the extent of the data on disk.

virtual void Kitware.VTK.vtkImageReader2.GetDataExtent ( IntPtr  _arg) [virtual]

Get/Set the extent of the data on disk.

virtual uint [] Kitware.VTK.vtkImageReader2.GetDataIncrements ( ) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual void Kitware.VTK.vtkImageReader2.GetDataIncrements ( IntPtr  data) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

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

Set/Get the origin of the data (location of first pixel in the file).

virtual void Kitware.VTK.vtkImageReader2.GetDataOrigin ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set/Get the origin of the data (location of first pixel in the file).

virtual void Kitware.VTK.vtkImageReader2.GetDataOrigin ( IntPtr  _arg) [virtual]

Set/Get the origin of the data (location of first pixel in the file).

Get the file format. Pixels are this type in the file.

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

Set/Get the spacing of the data in the file.

virtual void Kitware.VTK.vtkImageReader2.GetDataSpacing ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set/Get the spacing of the data in the file.

virtual void Kitware.VTK.vtkImageReader2.GetDataSpacing ( IntPtr  _arg) [virtual]

Set/Get the spacing of the data in the file.

virtual string Kitware.VTK.vtkImageReader2.GetDescriptiveName ( ) [virtual]

The number of dimensions stored in a file. This defaults to two.

virtual string Kitware.VTK.vtkImageReader2.GetFileExtensions ( ) [virtual]

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual string Kitware.VTK.vtkImageReader2.GetFileName ( ) [virtual]

Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.

Reimplemented in Kitware.VTK.vtkSLCReader.

Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.

Here is the call graph for this function:

When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)

When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1)

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

The sprintf-style format string used to build filename from FilePrefix and slice number.

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

Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.

Get the size of the header computed by this object.

Get the size of the header computed by this object.

Set/Get the internal file name.

Set/Get the number of scalar components.

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

Set/Get the byte swapping to explicitly swap the bytes of a file.

override int Kitware.VTK.vtkImageReader2.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkImageReader2.IsTypeOf ( string  type) [static]
virtual int Kitware.VTK.vtkImageReader2.OpenFile ( ) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual void Kitware.VTK.vtkImageReader2.SeekFile ( int  i,
int  j,
int  k 
) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual void Kitware.VTK.vtkImageReader2.SetDataByteOrder ( int  arg0) [virtual]

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.vtkImageReader2.SetDataExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [virtual]

Get/Set the extent of the data on disk.

virtual void Kitware.VTK.vtkImageReader2.SetDataExtent ( IntPtr  _arg) [virtual]

Get/Set the extent of the data on disk.

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

Set/Get the origin of the data (location of first pixel in the file).

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

Set/Get the origin of the data (location of first pixel in the file).

virtual void Kitware.VTK.vtkImageReader2.SetDataScalarType ( int  type) [virtual]

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

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

Set/Get the spacing of the data in the file.

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

Set/Get the spacing of the data in the file.

virtual void Kitware.VTK.vtkImageReader2.SetFileDimensionality ( int  _arg) [virtual]

The number of dimensions stored in a file. This defaults to two.

virtual void Kitware.VTK.vtkImageReader2.SetFileLowerLeft ( int  _arg) [virtual]

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual void Kitware.VTK.vtkImageReader2.SetFileName ( string  arg0) [virtual]

Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.

Reimplemented in Kitware.VTK.vtkDICOMImageReader, Kitware.VTK.vtkMINCImageReader, and Kitware.VTK.vtkSLCReader.

virtual void Kitware.VTK.vtkImageReader2.SetFileNames ( vtkStringArray  arg0) [virtual]

Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.

virtual void Kitware.VTK.vtkImageReader2.SetFileNameSliceOffset ( int  _arg) [virtual]

When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)

virtual void Kitware.VTK.vtkImageReader2.SetFileNameSliceSpacing ( int  _arg) [virtual]

When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1)

virtual void Kitware.VTK.vtkImageReader2.SetFilePattern ( string  arg0) [virtual]

The sprintf-style format string used to build filename from FilePrefix and slice number.

virtual void Kitware.VTK.vtkImageReader2.SetFilePrefix ( string  arg0) [virtual]

Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.

virtual void Kitware.VTK.vtkImageReader2.SetHeaderSize ( uint  size) [virtual]

If there is a tail on the file, you want to explicitly set the header size.

virtual void Kitware.VTK.vtkImageReader2.SetNumberOfScalarComponents ( int  _arg) [virtual]

Set/Get the number of scalar components.

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

Set/Get the byte swapping to explicitly swap the bytes of a file.

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

Set/Get the byte swapping to explicitly swap the bytes of a file.

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

Set/Get the byte swapping to explicitly swap the bytes of a file.

static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_CanReadFile_01 ( HandleRef  pThis,
string  arg0 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_ComputeInternalFileName_02 ( HandleRef  pThis,
int  slice 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_FileLowerLeftOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_FileLowerLeftOn_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataByteOrder_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataByteOrderAsString_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataExtent_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataExtent_08 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataExtent_09 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataIncrements_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataIncrements_11 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataOrigin_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataOrigin_13 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataOrigin_14 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataScalarType_15 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataSpacing_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataSpacing_17 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDataSpacing_18 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetDescriptiveName_19 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileDimensionality_20 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileExtensions_21 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileLowerLeft_22 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileName_23 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileNames_26 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileNameSliceOffset_24 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFileNameSliceSpacing_25 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFilePattern_27 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetFilePrefix_28 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkImageReader2.vtkImageReader2_GetHeaderSize_29 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkImageReader2.vtkImageReader2_GetHeaderSize_30 ( HandleRef  pThis,
uint  slice 
) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_GetInternalFileName_31 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetNumberOfScalarComponents_32 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_GetSwapBytes_33 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_IsA_34 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_IsTypeOf_35 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_NewInstance_37 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkImageReader2.vtkImageReader2_OpenFile_38 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageReader2.vtkImageReader2_SafeDownCast_39 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SeekFile_40 ( HandleRef  pThis,
int  i,
int  j,
int  k 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataByteOrder_41 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataByteOrderToBigEndian_42 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataByteOrderToLittleEndian_43 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataExtent_44 ( HandleRef  pThis,
int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataExtent_45 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataOrigin_46 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataOrigin_47 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarType_48 ( HandleRef  pThis,
int  type 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToChar_49 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToDouble_50 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToFloat_51 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToInt_52 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToShort_53 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToSignedChar_54 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToUnsignedChar_55 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToUnsignedInt_56 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataScalarTypeToUnsignedShort_57 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataSpacing_58 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetDataSpacing_59 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFileDimensionality_60 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFileLowerLeft_61 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFileName_62 ( HandleRef  pThis,
string  arg0 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFileNames_65 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFileNameSliceOffset_63 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFileNameSliceSpacing_64 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFilePattern_66 ( HandleRef  pThis,
string  arg0 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetFilePrefix_67 ( HandleRef  pThis,
string  arg0 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetHeaderSize_68 ( HandleRef  pThis,
uint  size 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetNumberOfScalarComponents_69 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SetSwapBytes_70 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SwapBytesOff_71 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageReader2.vtkImageReader2_SwapBytesOn_72 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkImageReader2.MRClassNameKey = "15vtkImageReader2" [static]
new const string Kitware.VTK.vtkImageReader2.MRFullTypeName = "Kitware.VTK.vtkImageReader2"

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