InputMbariFrameSeries Class Reference

InputMbariFrameSeries manages a series of input frames. More...

#include <MBARI/MbariFrameSeries.H>

Inheritance diagram for InputMbariFrameSeries:

[legend]

Collaboration diagram for InputMbariFrameSeries:

[legend]

List of all members.

Public Member Functions
	InputMbariFrameSeries (OptionManager &mgr, const std::string &descrName="Frame Series", const std::string &tagName="FrameSeries")
	Constructor.
virtual	~InputMbariFrameSeries ()
	Destructor.
Dims	peekDims (const int fnum)
	Get dims of a frame on disk, without fully reading it.
Image< PixRGB< byte > >	readRGB (const int fnum)
	Read a color frame.
void	setFileStem (const std::string &stem)
	Set the filename stem.

---

Detailed Description

InputMbariFrameSeries manages a series of input frames.

NOTE: this class was split off from the standard InputFrameSeries classes, in order to support the different input paradigm used in MbariResultViewer and test-mbari, while allowing the standard InputFrameSeries's interface to be minimized.

Definition at line 61 of file MbariFrameSeries.H.

---

Constructor & Destructor Documentation

InputMbariFrameSeries::InputMbariFrameSeries	(	OptionManager &	mgr,
		const std::string &	descrName = "Frame Series",
		const std::string &	tagName = "FrameSeries"
	)

Constructor.

Definition at line 84 of file MbariFrameSeries.C.

InputMbariFrameSeries::~InputMbariFrameSeries

(

)

[virtual]

Destructor.

Definition at line 95 of file MbariFrameSeries.C.

---

Member Function Documentation

Dims InputMbariFrameSeries::peekDims

(

const int

fnum

)

Get dims of a frame on disk, without fully reading it.

It is okay to call this before the model is started(). If input resizing is being done, this will return the resized dims. All in all, this will return the size of whatever you will get when calling readRGB().

Definition at line 99 of file MbariFrameSeries.C.

References Raster::getImageDims(), OModelParam< T >::getVal(), Dims::h(), sformat(), and Dims::w().

Image< PixRGB< byte > > InputMbariFrameSeries::readRGB

(

const int

fnum

)

Read a color frame.

Definition at line 110 of file MbariFrameSeries.C.

References Image< T >::getBounds(), OModelParam< T >::getVal(), inplaceEmbed(), Dims::isEmpty(), Raster::ReadRGB(), rescale(), sformat(), and ZEROS.

void InputMbariFrameSeries::setFileStem

(

const std::string &

stem

)

Set the filename stem.

Definition at line 131 of file MbariFrameSeries.C.

---

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

• src/MBARI/MbariFrameSeries.H
• src/MBARI/MbariFrameSeries.C