GDCM  2.4.5
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
gdcm::ImageCodec Class Referenceabstract

ImageCodec. More...

#include <gdcmImageCodec.h>

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

Public Member Functions

 ImageCodec ()
 
 ~ImageCodec ()
 
bool CanCode (TransferSyntax const &) const
 Return whether this coder support this transfer syntax (can code it) More...
 
bool CanDecode (TransferSyntax const &) const
 Return whether this decoder support this transfer syntax (can decode it) More...
 
virtual ImageCodecClone () const =0
 
bool Decode (DataElement const &is_, DataElement &os)
 Decode. More...
 
const unsigned int * GetDimensions () const
 
virtual bool GetHeaderInfo (std::istream &is_, TransferSyntax &ts)
 
bool GetLossyFlag () const
 
const LookupTableGetLUT () const
 
bool GetNeedByteSwap () const
 
unsigned int GetNumberOfDimensions () const
 
const PhotometricInterpretationGetPhotometricInterpretation () const
 
PixelFormatGetPixelFormat ()
 
const PixelFormatGetPixelFormat () const
 
unsigned int GetPlanarConfiguration () const
 
bool IsLossy () const
 
void SetDimensions (const unsigned int d[3])
 
void SetDimensions (const std::vector< unsigned int > &d)
 
void SetLossyFlag (bool l)
 
void SetLUT (LookupTable const &lut)
 
void SetNeedByteSwap (bool b)
 
void SetNeedOverlayCleanup (bool b)
 
void SetNumberOfDimensions (unsigned int dim)
 
void SetPhotometricInterpretation (PhotometricInterpretation const &pi)
 
virtual void SetPixelFormat (PixelFormat const &pf)
 
void SetPlanarConfiguration (unsigned int pc)
 
- Public Member Functions inherited from gdcm::Coder
virtual ~Coder ()
 
virtual bool Code (DataElement const &in_, DataElement &out_)
 Code. More...
 
- Public Member Functions inherited from gdcm::Decoder
virtual ~Decoder ()
 

Protected Types

typedef SmartPointer< LookupTableLUTPtr
 

Protected Member Functions

virtual bool AppendFrameEncode (std::ostream &out, const char *data, size_t datalen)
 
virtual bool AppendRowEncode (std::ostream &out, const char *data, size_t datalen)
 
bool DecodeByStreams (std::istream &is_, std::ostream &os)
 
bool DoByteSwap (std::istream &is_, std::ostream &os)
 
bool DoInvertMonochrome (std::istream &is_, std::ostream &os)
 
bool DoOverlayCleanup (std::istream &is_, std::ostream &os)
 
bool DoPaddedCompositePixelCode (std::istream &is_, std::ostream &os)
 
bool DoPlanarConfiguration (std::istream &is_, std::ostream &os)
 
bool DoSimpleCopy (std::istream &is_, std::ostream &os)
 
bool DoYBR (std::istream &is_, std::ostream &os)
 
virtual bool IsFrameEncoder ()
 
virtual bool IsRowEncoder ()
 
virtual bool IsValid (PhotometricInterpretation const &pi)
 
virtual bool StartEncode (std::ostream &os)
 
virtual bool StopEncode (std::ostream &os)
 
- Protected Member Functions inherited from gdcm::Coder
virtual bool InternalCode (const char *bv, unsigned long len, std::ostream &os)
 

Protected Attributes

unsigned int Dimensions [3]
 
bool LossyFlag
 
LUTPtr LUT
 
bool NeedByteSwap
 
bool NeedOverlayCleanup
 
unsigned int NumberOfDimensions
 
PixelFormat PF
 
PhotometricInterpretation PI
 
unsigned int PlanarConfiguration
 
bool RequestPaddedCompositePixelCode
 
bool RequestPlanarConfiguration
 

Friends

class FileChangeTransferSyntax
 
class ImageChangePhotometricInterpretation
 

Detailed Description

ImageCodec.

Note
Main codec, this is a central place for all implementation

Member Typedef Documentation

Constructor & Destructor Documentation

gdcm::ImageCodec::ImageCodec ( )
gdcm::ImageCodec::~ImageCodec ( )

Member Function Documentation

virtual bool gdcm::ImageCodec::AppendFrameEncode ( std::ostream &  out,
const char *  data,
size_t  datalen 
)
protectedvirtual
virtual bool gdcm::ImageCodec::AppendRowEncode ( std::ostream &  out,
const char *  data,
size_t  datalen 
)
protectedvirtual
bool gdcm::ImageCodec::CanCode ( TransferSyntax const &  ) const
inlinevirtual

Return whether this coder support this transfer syntax (can code it)

Implements gdcm::Coder.

Reimplemented in gdcm::JPEGCodec, gdcm::RLECodec, gdcm::PVRGCodec, gdcm::JPEG2000Codec, gdcm::JPEGLSCodec, gdcm::PNMCodec, gdcm::PGXCodec, gdcm::KAKADUCodec, and gdcm::RAWCodec.

bool gdcm::ImageCodec::CanDecode ( TransferSyntax const &  ) const
inlinevirtual

Return whether this decoder support this transfer syntax (can decode it)

Implements gdcm::Decoder.

Reimplemented in gdcm::JPEGCodec, gdcm::RLECodec, gdcm::PVRGCodec, gdcm::JPEG2000Codec, gdcm::JPEGLSCodec, gdcm::PNMCodec, gdcm::RAWCodec, gdcm::PGXCodec, and gdcm::KAKADUCodec.

virtual ImageCodec* gdcm::ImageCodec::Clone ( ) const
pure virtual
bool gdcm::ImageCodec::Decode ( DataElement const &  ,
DataElement  
)
virtual
bool gdcm::ImageCodec::DecodeByStreams ( std::istream &  is_,
std::ostream &  os 
)
protectedvirtual
bool gdcm::ImageCodec::DoByteSwap ( std::istream &  is_,
std::ostream &  os 
)
protected
bool gdcm::ImageCodec::DoInvertMonochrome ( std::istream &  is_,
std::ostream &  os 
)
protected
bool gdcm::ImageCodec::DoOverlayCleanup ( std::istream &  is_,
std::ostream &  os 
)
protected
bool gdcm::ImageCodec::DoPaddedCompositePixelCode ( std::istream &  is_,
std::ostream &  os 
)
protected
bool gdcm::ImageCodec::DoPlanarConfiguration ( std::istream &  is_,
std::ostream &  os 
)
protected
bool gdcm::ImageCodec::DoSimpleCopy ( std::istream &  is_,
std::ostream &  os 
)
protected
bool gdcm::ImageCodec::DoYBR ( std::istream &  is_,
std::ostream &  os 
)
protected
const unsigned int* gdcm::ImageCodec::GetDimensions ( ) const
inline
virtual bool gdcm::ImageCodec::GetHeaderInfo ( std::istream &  is_,
TransferSyntax ts 
)
virtual
bool gdcm::ImageCodec::GetLossyFlag ( ) const
const LookupTable& gdcm::ImageCodec::GetLUT ( ) const
inline
bool gdcm::ImageCodec::GetNeedByteSwap ( ) const
inline
unsigned int gdcm::ImageCodec::GetNumberOfDimensions ( ) const
const PhotometricInterpretation& gdcm::ImageCodec::GetPhotometricInterpretation ( ) const
PixelFormat& gdcm::ImageCodec::GetPixelFormat ( )
inline
const PixelFormat& gdcm::ImageCodec::GetPixelFormat ( ) const
inline
unsigned int gdcm::ImageCodec::GetPlanarConfiguration ( ) const
inline
virtual bool gdcm::ImageCodec::IsFrameEncoder ( )
protectedvirtual
bool gdcm::ImageCodec::IsLossy ( ) const
virtual bool gdcm::ImageCodec::IsRowEncoder ( )
protectedvirtual
virtual bool gdcm::ImageCodec::IsValid ( PhotometricInterpretation const &  pi)
protectedvirtual

Reimplemented in gdcm::JPEGCodec.

void gdcm::ImageCodec::SetDimensions ( const unsigned int  d[3])
void gdcm::ImageCodec::SetDimensions ( const std::vector< unsigned int > &  d)
void gdcm::ImageCodec::SetLossyFlag ( bool  l)
void gdcm::ImageCodec::SetLUT ( LookupTable const &  lut)
inline
void gdcm::ImageCodec::SetNeedByteSwap ( bool  b)
inline
void gdcm::ImageCodec::SetNeedOverlayCleanup ( bool  b)
inline
void gdcm::ImageCodec::SetNumberOfDimensions ( unsigned int  dim)
void gdcm::ImageCodec::SetPhotometricInterpretation ( PhotometricInterpretation const &  pi)
virtual void gdcm::ImageCodec::SetPixelFormat ( PixelFormat const &  pf)
inlinevirtual

Reimplemented in gdcm::JPEGCodec.

Examples:
ExtractIconFromFile.cxx.
void gdcm::ImageCodec::SetPlanarConfiguration ( unsigned int  pc)
inline
virtual bool gdcm::ImageCodec::StartEncode ( std::ostream &  os)
protectedvirtual
virtual bool gdcm::ImageCodec::StopEncode ( std::ostream &  os)
protectedvirtual

Friends And Related Function Documentation

friend class FileChangeTransferSyntax
friend

This is a high level API to encode in a streaming fashion. Each plugin will handle differently the caching mecanism so that a limited memory is used when compressing dataset. Codec will fall into two categories:

  • Full row encoder: only a single scanline (row) of data is needed to be loaded at a time;
  • Full frame encoder (default): a complete frame (row x col) is needed to be loaded at a time

Member Data Documentation

unsigned int gdcm::ImageCodec::Dimensions[3]
protected
bool gdcm::ImageCodec::LossyFlag
protected
LUTPtr gdcm::ImageCodec::LUT
protected
bool gdcm::ImageCodec::NeedByteSwap
protected
bool gdcm::ImageCodec::NeedOverlayCleanup
protected
unsigned int gdcm::ImageCodec::NumberOfDimensions
protected
PixelFormat gdcm::ImageCodec::PF
protected
PhotometricInterpretation gdcm::ImageCodec::PI
protected
unsigned int gdcm::ImageCodec::PlanarConfiguration
protected
bool gdcm::ImageCodec::RequestPaddedCompositePixelCode
protected
bool gdcm::ImageCodec::RequestPlanarConfiguration
protected

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

Generated on Fri Sep 25 2015 17:58:31 for GDCM by doxygen 1.8.9.1
SourceForge.net Logo