Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
gdcm::PixelWriteConvert

gdcm::PixelWriteConvert Class Reference

Utility container for gathering the various forms the pixel data migth take during the user requiered processes. More...

#include <gdcmPixelWriteConvert.h>

Inheritance diagram for gdcm::PixelWriteConvert:

Inheritance graph
[legend]
Collaboration diagram for gdcm::PixelWriteConvert:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void Print (std::ostream &=std::cout, std::string const &="")
 Printer.
void SetPrintLevel (int level)
 Sets the print level for the Dicom Header Elements.
int GetPrintLevel ()
 Gets the print level for the Dicom Entries.

Protected Attributes

int PrintLevel
 Amount of printed details for each Dicom Entries : 0 : stands for the least detail level.

Private Member Functions

 PixelWriteConvert ()
 Constructor.
virtual ~PixelWriteConvert ()
 Destructor.
void SetReadData (uint8_t *data, size_t size)
 sets Read Data (and size)
uint8_t * GetReadData ()
 returns ReadData
size_t GetReadDataSize ()
 returns ReadDataSize
void SetUserData (uint8_t *data, size_t size)
 Sets the internal pointer to the caller's inData image representation, BUT WITHOUT COPYING THE DATA.
  • 'image' Pixels are presented as C-like 2D arrays : line per line.
  • 'volume'Pixels are presented as C-like 3D arrays : plane per plane.

uint8_t * GetUserData ()
 returns UserData
size_t GetUserDataSize ()
 returns UserDataSize
uint8_t * GetData ()
 Get Data (UserData or ReadData).
size_t GetDataSize ()
 Get Data Size (UserData or ReadData).

Private Attributes

uint8_t * ReadData
 Pixel data represented as RGB after LUT color interpretation.
size_t ReadDataSize
 Size of RGB image.
uint8_t * UserData
 User pixel data.
size_t UserDataSize
 Size of User image.

Friends

class FileHelper

Detailed Description

Utility container for gathering the various forms the pixel data migth take during the user requiered processes.

Warning:
None of the methods may be called by end user (they have no meaning outside the class FileHelper)

Definition at line 34 of file gdcmPixelWriteConvert.h.

Constructor & Destructor Documentation

gdcm::PixelWriteConvert::PixelWriteConvert (   )  [private]
 

Constructor.

Definition at line 29 of file gdcmPixelWriteConvert.cxx.

References ReadData, ReadDataSize, UserData, and UserDataSize.

00030 {
00031    ReadData     = 0;
00032    ReadDataSize = 0;
00033 
00034    UserData     = 0;
00035    UserDataSize = 0;
00036 }

gdcm::PixelWriteConvert::~PixelWriteConvert (   )  [private, virtual]
 

Destructor.

Definition at line 41 of file gdcmPixelWriteConvert.cxx.

00042 {
00043 }

Member Function Documentation

uint8_t * gdcm::PixelWriteConvert::GetData (   )  [private]
 

Get Data (UserData or ReadData).

Returns:
data (uint8_t is for prototyping. if your data is *not* uint8_t, just cast the returned pointer)

Definition at line 82 of file gdcmPixelWriteConvert.cxx.

References ReadData, and UserData.

Referenced by gdcm::FileHelper::SetWriteToRaw(), and gdcm::FileHelper::SetWriteToRGB().

00083 {
00084    if ( UserData )
00085    {
00086       return UserData;
00087    }
00088    else
00089    {
00090       return ReadData;
00091    }
00092 }

size_t gdcm::PixelWriteConvert::GetDataSize (   )  [private]
 

Get Data Size (UserData or ReadData).

Returns:
size, in bytes.

Definition at line 98 of file gdcmPixelWriteConvert.cxx.

References ReadDataSize, UserData, and UserDataSize.

Referenced by gdcm::FileHelper::SetWriteToRaw(), and gdcm::FileHelper::SetWriteToRGB().

00099 {
00100    if ( UserData )
00101    {
00102       return UserDataSize;
00103    }
00104    else
00105    {
00106       return ReadDataSize;
00107    }
00108 }

int gdcm::Base::GetPrintLevel (   )  [inline, inherited]
 

Gets the print level for the Dicom Entries.

Definition at line 50 of file gdcmBase.h.

00050 { return PrintLevel; }

uint8_t* gdcm::PixelWriteConvert::GetReadData (   )  [inline, private]
 

returns ReadData

Definition at line 46 of file gdcmPixelWriteConvert.h.

00046 { return ReadData; }

size_t gdcm::PixelWriteConvert::GetReadDataSize (   )  [inline, private]
 

returns ReadDataSize

Definition at line 48 of file gdcmPixelWriteConvert.h.

00048 { return ReadDataSize; }

uint8_t* gdcm::PixelWriteConvert::GetUserData (   )  [inline, private]
 

returns UserData

Definition at line 52 of file gdcmPixelWriteConvert.h.

Referenced by gdcm::FileHelper::CheckWriteIntegrity(), gdcm::FileHelper::GetImageData(), gdcm::FileHelper::GetImageDataRawSize(), gdcm::FileHelper::GetImageDataSize(), gdcm::FileHelper::GetUserData(), and gdcm::FileHelper::WriteRawData().

00052 { return UserData; }

size_t gdcm::PixelWriteConvert::GetUserDataSize (   )  [inline, private]
 

returns UserDataSize

Definition at line 54 of file gdcmPixelWriteConvert.h.

Referenced by gdcm::FileHelper::CheckWriteIntegrity(), gdcm::FileHelper::GetImageDataRawSize(), gdcm::FileHelper::GetImageDataSize(), gdcm::FileHelper::GetUserDataSize(), and gdcm::FileHelper::WriteRawData().

00054 { return UserDataSize; }

virtual void gdcm::Base::Print (  std::ostream &  = std::cout,
std::string const &  = ""
)  [inline, virtual, inherited]
 

Printer.

Reimplemented in gdcm::CommandManager, gdcm::DataEntry, gdcm::DicomDir, gdcm::DicomDirElement, gdcm::DicomDirImage, gdcm::DicomDirMeta, gdcm::DicomDirPatient, gdcm::DicomDirSerie, gdcm::DicomDirStudy, gdcm::DicomDirVisit, gdcm::DicomEntry, gdcm::Dict, gdcm::DictEntry, gdcm::DictGroupName, gdcm::DictSet, gdcm::DirList, gdcm::DocEntry, gdcm::ElementSet, gdcm::FileHelper, gdcm::JPEGFragment, gdcm::PixelReadConvert, gdcm::RLEFrame, gdcm::SeqEntry, gdcm::SerieHelper, gdcm::SQItem, and gdcm::VR.

Definition at line 42 of file gdcmBase.h.

00043                                                {};

void gdcm::Base::SetPrintLevel (  int  level  )  [inline, inherited]
 

Sets the print level for the Dicom Header Elements.

Note:
0 for Light Print; 1 for 'medium' Print, 2 for Heavy Print

Definition at line 47 of file gdcmBase.h.

Referenced by gdcm::SQItem::Print(), gdcm::SeqEntry::Print(), gdcm::FileHelper::Print(), gdcm::ElementSet::Print(), and gdcm::DicomDir::Print().

00047 { PrintLevel = level; }

void gdcm::PixelWriteConvert::SetReadData (  uint8_t *  data,
size_t  size
)  [private]
 

sets Read Data (and size)

Parameters:
data data (uint8_t is for prototyping. if your data is not uint8_t just cast the pointer for calling the method)
size data size, in bytes

Definition at line 53 of file gdcmPixelWriteConvert.cxx.

References ReadData, and ReadDataSize.

Referenced by gdcm::FileHelper::SetWriteToRaw(), and gdcm::FileHelper::SetWriteToRGB().

00054 {
00055    ReadData = data;
00056    ReadDataSize = size;
00057 }

void gdcm::PixelWriteConvert::SetUserData (  uint8_t *  data,
size_t  size
)  [private]
 

Sets the internal pointer to the caller's inData image representation, BUT WITHOUT COPYING THE DATA.

  • 'image' Pixels are presented as C-like 2D arrays : line per line.
  • 'volume'Pixels are presented as C-like 3D arrays : plane per plane.

Warning:
Since the pixels are not copied, it is the caller's responsability not to deallocate its data before gdcm uses them (e.g. with the Write() method )
Parameters:
data data (uint8_t is for prototyping. if your data is not uint8_t just cast the pointer for calling the method)
size size, in bytes.

Definition at line 71 of file gdcmPixelWriteConvert.cxx.

References UserData, and UserDataSize.

Referenced by gdcm::FileHelper::SetUserData().

00072 {
00073    UserData = data;
00074    UserDataSize = size;
00075 }

Friends And Related Function Documentation

friend class FileHelper [friend]
 

Definition at line 36 of file gdcmPixelWriteConvert.h.

Member Data Documentation

int gdcm::Base::PrintLevel [protected, inherited]
 

Amount of printed details for each Dicom Entries : 0 : stands for the least detail level.

Definition at line 55 of file gdcmBase.h.

Referenced by gdcm::SQItem::Print(), gdcm::SeqEntry::Print(), gdcm::FileHelper::Print(), gdcm::ElementSet::Print(), gdcm::DocEntry::Print(), gdcm::DictEntry::Print(), gdcm::DicomDirStudy::Print(), gdcm::DicomDirSerie::Print(), gdcm::DicomDirPatient::Print(), gdcm::DicomDirMeta::Print(), gdcm::DicomDir::Print(), and gdcm::DataEntry::Print().

uint8_t* gdcm::PixelWriteConvert::ReadData [private]
 

Pixel data represented as RGB after LUT color interpretation.

Definition at line 63 of file gdcmPixelWriteConvert.h.

Referenced by GetData(), PixelWriteConvert(), and SetReadData().

size_t gdcm::PixelWriteConvert::ReadDataSize [private]
 

Size of RGB image.

Definition at line 65 of file gdcmPixelWriteConvert.h.

Referenced by GetDataSize(), PixelWriteConvert(), and SetReadData().

uint8_t* gdcm::PixelWriteConvert::UserData [private]
 

User pixel data.

Definition at line 68 of file gdcmPixelWriteConvert.h.

Referenced by GetData(), GetDataSize(), PixelWriteConvert(), and SetUserData().

size_t gdcm::PixelWriteConvert::UserDataSize [private]
 

Size of User image.

Definition at line 70 of file gdcmPixelWriteConvert.h.

Referenced by GetDataSize(), PixelWriteConvert(), and SetUserData().

The documentation for this class was generated from the following files:
Generated on Fri Jan 20 10:15:07 2006 for gdcm by  doxygen 1.4.4