gdcm::RLEFramesInfo Class Reference

Utility class for gathering the informations of the collection of RLE frame[s] (see RLEFrame) when handling "Encapsulated RLE Compressed Images" (see PS 3.5-2003 annex G). Note: a classical image can be considered as the degenerated case of a multiframe image. In this case the collection is limited to a single individual frame. The informations on each frame are obtained during the pixel parsing of a gdcm::File (refer to File::ComputeRLEInfo() ). They shall be used when (if necessary) decoding the frames. More...

#include <gdcmRLEFramesInfo.h>

List of all members.

Private Types
typedef std::list< RLEFrame * >	RLEFrameList
Private Member Functions
	~RLEFramesInfo ()
void	Print (std::ostream &os=std::cout, std::string indent="")
	Print self.
bool	DecompressRLEFile (std::ifstream *fp, uint8_t *subRaw, int xSize, int ySize, int zSize, int bitsAllocated)
	Reads from disk the Pixel Data of 'Run Length Encoded' Dicom encapsulated file and decompress it.
bool	ConvertRLE16BitsFromRLE8Bits (uint8_t *subRaw, int xSize, int ySize, int numberOfFrames)
	We assume Raw contains the decoded RLE pixels but as 8 bits per pixel. We convert those pixels to 16 bits per pixel.
void	AddFrame (RLEFrame *frame)
RLEFrame *	GetFirstFrame ()
RLEFrame *	GetNextFrame ()
Private Attributes
RLEFrameList	Frames
RLEFrameList::iterator	ItFrames
Friends
class	PixelReadConvert
class	File

---

Detailed Description

Utility class for gathering the informations of the collection of RLE frame[s] (see RLEFrame) when handling "Encapsulated RLE Compressed Images" (see PS 3.5-2003 annex G). Note: a classical image can be considered as the degenerated case of a multiframe image. In this case the collection is limited to a single individual frame. The informations on each frame are obtained during the pixel parsing of a gdcm::File (refer to File::ComputeRLEInfo() ). They shall be used when (if necessary) decoding the frames.

This class is simply a stl list<> of RLEFrame.

Definition at line 43 of file gdcmRLEFramesInfo.h.

---

Member Typedef Documentation

typedef std::list<RLEFrame *> gdcm::RLEFramesInfo::RLEFrameList [private]

Definition at line 62 of file gdcmRLEFramesInfo.h.

---

Constructor & Destructor Documentation

gdcm::RLEFramesInfo::~RLEFramesInfo (   )  [private]

Definition at line 27 of file gdcmRLEFramesInfo.cxx. References Frames. { for(RLEFrameList::iterator it = Frames.begin(); it != Frames.end(); ++it) { delete (*it); } Frames.clear(); }

---

Member Function Documentation

void gdcm::RLEFramesInfo::AddFrame (  RLEFrame *  frame  )  [private]

Definition at line 38 of file gdcmRLEFramesInfo.cxx. References Frames. Referenced by gdcm::File::ComputeRLEInfo(). { Frames.push_back(frame); }

bool gdcm::RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits (  uint8_t *  raw, int  xSize, int  ySize, int  numberOfFrames )  [private]

We assume Raw contains the decoded RLE pixels but as 8 bits per pixel. We convert those pixels to 16 bits per pixel. Parameters: raw  raw xSize  x Size ySize  y Size numberOfFrames  number of frames Returns: Boolean always true Definition at line 105 of file gdcmRLEFramesInfo.cxx. References gdcm::Util::IsCurrentProcessorBigEndian(). Referenced by DecompressRLEFile(). { size_t pixelNumber = xSize * ySize; size_t rawSize = pixelNumber * numberOfFrames * 2; // We assumed Raw contains the decoded RLE pixels but as // 8 bits per pixel. In order to convert those pixels to 16 bits // per pixel we cannot work in place within Raw and hence // we copy it in a safe place, say copyRaw. uint8_t *copyRaw = new uint8_t[rawSize]; memmove( copyRaw, raw, rawSize ); uint8_t *x = raw; uint8_t *a; uint8_t *b; // Warning : unckecked patch to see the behaviour on Big Endian Processors if ( !Util::IsCurrentProcessorBigEndian() ) { a = copyRaw; // beginning of 'low bytes' b = a + pixelNumber; // beginning of 'hight bytes' } else { b = copyRaw; // beginning of 'low bytes' a = b + pixelNumber; // beginning of 'hight bytes' } // Re order bytes for ( int i = 0; i < numberOfFrames; i++ ) { for ( unsigned int j = 0; j < pixelNumber; j++ ) { *(x++) = *(b++); *(x++) = *(a++); } } delete[] copyRaw; return true; }

bool gdcm::RLEFramesInfo::DecompressRLEFile (  std::ifstream *  fp, uint8_t *  raw, int  xSize, int  ySize, int  zSize, int  bitsAllocated )  [private]

Reads from disk the Pixel Data of 'Run Length Encoded' Dicom encapsulated file and decompress it. Parameters: fp  already open File Pointer from which the pixel data should be read raw  raw xSize  x Size ySize  y Size zSize  z Size bitsAllocated  Bits allocated Returns: Boolean Definition at line 73 of file gdcmRLEFramesInfo.cxx. References ConvertRLE16BitsFromRLE8Bits(), and Frames. Referenced by gdcm::PixelReadConvert::ReadAndDecompressPixelData(). { uint8_t *subRaw = raw; long rawSegmentSize = xSize * ySize; // Loop on the frame[s] for(RLEFrameList::iterator it = Frames.begin(); it != Frames.end(); ++it) { subRaw = (*it)->ReadAndDecompressRLEFrame( subRaw, rawSegmentSize, fp); } if ( bitsAllocated == 16 ) { // Try to deal with RLE 16 Bits ConvertRLE16BitsFromRLE8Bits( raw, xSize, ySize, zSize ); } return true; }

RLEFrame * gdcm::RLEFramesInfo::GetFirstFrame (   )  [private]

Definition at line 43 of file gdcmRLEFramesInfo.cxx. References Frames, and ItFrames. { ItFrames = Frames.begin(); if (ItFrames != Frames.end()) return *ItFrames; return NULL; }

RLEFrame * gdcm::RLEFramesInfo::GetNextFrame (   )  [private]

Definition at line 51 of file gdcmRLEFramesInfo.cxx. References Frames, gdcmAssertMacro, and ItFrames. { gdcmAssertMacro (ItFrames != Frames.end()); ++ItFrames; if (ItFrames != Frames.end()) return *ItFrames; return NULL; }

void gdcm::RLEFramesInfo::Print (  std::ostream &  os = std::cout, std::string  indent = "" )  [private]

Print self. Parameters: indent  Indentation string to be prepended during printing. os  Stream to print to. Definition at line 164 of file gdcmRLEFramesInfo.cxx. References Frames. { os << std::endl; os << indent << "----------------- RLE frames --------------------------------" << std::endl; os << indent << "Total number of Frames : " << Frames.size() << std::endl; int frameNumber = 0; for(RLEFrameList::iterator it = Frames.begin(); it != Frames.end(); ++it) { os << indent << " frame number :" << frameNumber++ << std::endl; (*it)->Print( os, indent + " " ); } }

---

Friends And Related Function Documentation

friend class File [friend]

Definition at line 46 of file gdcmRLEFramesInfo.h.

friend class PixelReadConvert [friend]

Definition at line 45 of file gdcmRLEFramesInfo.h.

---

Member Data Documentation

RLEFrameList gdcm::RLEFramesInfo::Frames [private]

Definition at line 64 of file gdcmRLEFramesInfo.h. Referenced by AddFrame(), DecompressRLEFile(), GetFirstFrame(), GetNextFrame(), Print(), and ~RLEFramesInfo().

RLEFrameList::iterator gdcm::RLEFramesInfo::ItFrames [private]

Definition at line 65 of file gdcmRLEFramesInfo.h. Referenced by GetFirstFrame(), and GetNextFrame().

---

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

• gdcmRLEFramesInfo.h
• gdcmRLEFramesInfo.cxx

---