MgzJDecoder Class Reference

Low-level decoder for multi-frame "mgzJ" file format. More...

#include <Media/MgzJDecoder.H>

Collaboration diagram for MgzJDecoder:

[legend]

List of all members.

Public Member Functions
	MgzJDecoder (const std::string &fname)
	Constructor.
	MgzJDecoder ()
	Defualt Constructor.
virtual	~MgzJDecoder ()
	Virtual destructor for safe inheritance.
virtual GenericFrame	readFrame ()
	Read an RGB image from the stream.
void	init ()
	Open the filename and init the structure.
void	shutdown ()
void	setFilename (const std::string &fname)
int	getNumFrames ()
	Get the total number of frames in the journal.
int	getFrameNum ()
	Get the current frame num.
bool	setFrameNumber (unsigned int n)
	Set the current frame number.

---

Detailed Description

Low-level decoder for multi-frame "mgzJ" file format.

Definition at line 45 of file MgzJDecoder.H.

---

Constructor & Destructor Documentation

MgzJDecoder::MgzJDecoder

(

const std::string &

fname

)

Constructor.

Definition at line 39 of file MgzJDecoder.C.

References init().

MgzJDecoder::MgzJDecoder

(

)

[inline]

Defualt Constructor.

Definition at line 52 of file MgzJDecoder.H.

MgzJDecoder::~MgzJDecoder

(

)

[virtual]

Virtual destructor for safe inheritance.

Definition at line 47 of file MgzJDecoder.C.

---

Member Function Documentation

int MgzJDecoder::getFrameNum

(

)

[inline]

Get the current frame num.

Definition at line 69 of file MgzJDecoder.H.

int MgzJDecoder::getNumFrames

(

)

Get the total number of frames in the journal.

Definition at line 243 of file MgzJDecoder.C.

Referenced by MgzJInputStream::getFrameRange(), and CachedFrameLoader::getFrameRange().

void MgzJDecoder::init

(

)

Open the filename and init the structure.

Definition at line 54 of file MgzJDecoder.C.

References ASSERT, and in.

Referenced by MgzJDecoder().

GenericFrame MgzJDecoder::readFrame

(

)

[virtual]

Read an RGB image from the stream.

Definition at line 118 of file MgzJDecoder.C.

References ArrayData< T >::dataw(), Image< T >::getArrayPtr(), getFrameSize(), GenericFrame::GRAY_F32, GenericFrame::GRAY_U16, GenericFrame::GRAY_U8, NO_INIT, GenericFrame::RGB_F32, GenericFrame::RGB_U16, GenericFrame::RGB_U8, Dims::sz(), and ArrayHandle< T >::uniq().

Referenced by CachedFrameLoader::getFrame(), and MgzJInputStream::readFrame().

bool MgzJDecoder::setFrameNumber

(

unsigned int

n

)

Set the current frame number.

Definition at line 249 of file MgzJDecoder.C.

Referenced by CachedFrameLoader::getFrame(), and MgzJInputStream::setFrameNumber().

---

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

• src/Media/MgzJDecoder.H
• src/Media/MgzJDecoder.C