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:

[legend]Collaboration diagram for mitkVolumeReader:

[legend]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)
mitkVolume *	GetOutput ()

---

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; 
    aReader->AddFileName(file1); 
    aReader->AddFileName(file2); 
    ...  ...  ... 
    if (aReader->Run())
    { 
        mitkVolume *aVolume = aReader->GetOutput(); 
        Using aVolume
    }

---

Member Function Documentation

mitkVolume* mitkVolumeReader::GetOutput (   )

Get the output volume the reader has read. Returns: the output volume.

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

Print the necessary information about this object for the debugging purpose. Parameters: 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. Parameters: 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 Note: 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:

• mitkVolumeReader.h

---