GDCM: gdcm::PNMCodec Class Reference

GDCM 3.2.8

Public Member Functions | List of all members
gdcm::PNMCodec Class Reference

Class to do PNM. More...

`#include <gdcmPNMCodec.h>`

Inheritance diagram for gdcm::PNMCodec:
[legend]
Collaboration diagram for gdcm::PNMCodec:
[legend]

## Public Member Functions
| PNMCodec ()
| ~PNMCodec () override
bool | CanCode (TransferSyntax const &ts) const override
| Return whether this coder support this transfer syntax (can code it).
bool | CanDecode (TransferSyntax const &ts) const override
| Return whether this decoder support this transfer syntax (can decode it).
ImageCodec * | Clone () const override
unsigned long | GetBufferLength () const
bool | GetHeaderInfo (std::istream &is, TransferSyntax &ts) override
bool | Read (const char *filename, DataElement &out) const
void | SetBufferLength (unsigned long l)
bool | Write (const char *filename, const DataElement &out) const
Public Member Functions inherited from gdcm::ImageCodec
| ImageCodec ()
| ~ImageCodec () override
bool | CleanupUnusedBits (char *data, size_t datalen)
bool | Decode (DataElement const &is_, DataElement &os) override
| Decode.
const unsigned int * | GetDimensions () const
bool | GetLossyFlag () const
const LookupTable & | GetLUT () const
bool | GetNeedByteSwap () const
unsigned int | GetNumberOfDimensions () const
const PhotometricInterpretation & | GetPhotometricInterpretation () const
PixelFormat & | GetPixelFormat ()
const PixelFormat & | GetPixelFormat () const
unsigned int | GetPlanarConfiguration () const
bool | IsLossy () const
void | SetDimensions (const std::vector< unsigned int > &d)
void | SetDimensions (const unsigned int d[3])
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 ()=default
virtual bool | Code (DataElement const &in_, DataElement &out_)
| Code.
Public Member Functions inherited from gdcm::Decoder
virtual | ~Decoder ()=default

## Additional Inherited Members
Protected Types inherited from gdcm::ImageCodec
typedef SmartPointer< LookupTable > | LUTPtr
Protected Member Functions inherited from gdcm::ImageCodec
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) override
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)
bool | DoYBRFull422 (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 inherited from gdcm::ImageCodec
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

## Detailed Description

Class to do PNM.

PNM is the Portable anymap file format. The main web page can be found at: http://netpbm.sourceforge.net/

Note
  Only support P5 & P6 PNM file (binary grayscale and binary rgb)

Examples
  ExtractIconFromFile.cxx.

## Constructor & Destructor Documentation

## ◆ PNMCodec()

gdcm::PNMCodec::PNMCodec | ( |  | ) |

## ◆ ~PNMCodec()

gdcm::PNMCodec::~PNMCodec | ( |  | ) |
| override

## Member Function Documentation

## ◆ CanCode()

bool gdcm::PNMCodec::CanCode | ( | TransferSyntax const & |  | ) | const
| overridevirtual

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

Reimplemented from gdcm::ImageCodec.

## ◆ CanDecode()

bool gdcm::PNMCodec::CanDecode | ( | TransferSyntax const & |  | ) | const
| overridevirtual

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

Reimplemented from gdcm::ImageCodec.

## ◆ Clone()

ImageCodec * gdcm::PNMCodec::Clone | ( |  | ) | const
| overridevirtual

Implements gdcm::ImageCodec.

References gdcm::ImageCodec::ImageCodec().

## ◆ GetBufferLength()

unsigned long gdcm::PNMCodec::GetBufferLength | ( |  | ) | const
| inline

## ◆ GetHeaderInfo()

bool gdcm::PNMCodec::GetHeaderInfo | ( | std::istream & | is,
|  | TransferSyntax & | ts )
| overridevirtual

Reimplemented from gdcm::ImageCodec.

## ◆ Read()

bool gdcm::PNMCodec::Read | ( | const char * | filename,
|  | DataElement & | out ) const

## ◆ SetBufferLength()

void gdcm::PNMCodec::SetBufferLength | ( | unsigned long | l | ) |
| inline

## ◆ Write()

bool gdcm::PNMCodec::Write | ( | const char * | filename,
|  | const DataElement & | out ) const

Examples
  ExtractIconFromFile.cxx.

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

- gdcmPNMCodec.h