Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

mitkVolumeReader Class Reference

mitkVolumeReader - an abstract class represents a volume reader to read image/volume files More...

#include <mitkVolumeReader.h>

Inherits mitkReader.

Inherited by mitkAnalyzeImageReader, mitkBMPReader, mitkCacheVolumeReader, mitkDICOMReader, mitkIM0Reader, mitkJPEGReader, mitkMetaImageReader, mitkNetCDFImageReader, mitkRawFilesReader, mitkRawFilesReader, mitkRawReader, and mitkTIFFReader.

Inheritance diagram for mitkVolumeReader:

Inheritance graph
Collaboration diagram for mitkVolumeReader:

Collaboration graph
List of all members.

Public Member Functions

virtual void PrintSelf (ostream &os)
void SetOoCSupport (char const *diskPath=mitkOoCGlobalSettings::DiskCachePath, unsigned int bufSliceNum=mitkOoCGlobalSettings::BufferedSliceNumber, bool supportOoC=true)
mitkVolumeGetOutput ()

Detailed Description

mitkVolumeReader - an abstract class represents a volume reader to read image/volume files

mitkVolumeReader defines the interface of all of the volume readers. To use a concrete volume reader, for example, mitkBMPReader, the code snippet is:

    mitkBMPReader *aReader = new mitkBMPReader; 
    ...  ...  ... 
    if (aReader->Run())
        mitkVolume *aVolume = aReader->GetOutput(); 
        Using aVolume

Member Function Documentation

mitkVolume* mitkVolumeReader::GetOutput  ) 

Get the output volume the reader has read.

the output volume.

virtual void mitkVolumeReader::PrintSelf ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose.

os The specified ostream to output information.

Reimplemented from mitkReader.

Reimplemented in mitkAnalyzeImageReader, mitkBMPReader, mitkCacheVolumeReader, mitkDICOMReader, mitkJPEGReader, mitkMetaImageReader, mitkNetCDFImageReader, mitkRawFilesReader, mitkRawReader, mitkTIFFReader, and mitkRawFilesReader.

void mitkVolumeReader::SetOoCSupport char const *  diskPath = mitkOoCGlobalSettings::DiskCachePath,
unsigned int  bufSliceNum = mitkOoCGlobalSettings::BufferedSliceNumber,
bool  supportOoC = true

Let the reader support out-of-core volume data.

diskPath the path in the disk to cache the volume data
bufSliceNum the number of slices to cache in the main memory
supportOoC whether to turn on out-of-core support
The parameter diskPath must be specified (not NULL) if you really want to turn on out-of-core support, if not, the value of supportOoC will be ignored even if it is set to true.

The documentation for this class was generated from the following file:
Generated on Tue Feb 25 15:07:21 2014 for MITK (Medical Imaging ToolKit) by  doxygen 1.4.3