firevision::HistogramFile Class Reference

A fileformat for histograms. More...

#include <>>

Inheritance diagram for firevision::HistogramFile:

List of all members.

Public Types
typedef std::list < HistogramBlock * >	HistogramBlockList
	Convenience typdef for a STL list of pointers to histogram blocks.
Public Types inherited from firevision::FireVisionDataFile
typedef std::list < FireVisionDataFileBlock * >	BlockList
	List of FireVision data file blocks.

Public Member Functions
	HistogramFile ()
	Constructor.
	~HistogramFile ()
	Destructor.
void	add_histogram_block (HistogramBlock *block)
	Adds a new histogram block to the file.
HistogramBlockList	histogram_blocks ()
	Generates a list of histogram blocks attached to the file.
uint32_t	get_value (hint_t object_type, uint16_t x, uint16_t y, uint16_t z)
	Get a value from a certain histogram.
void	set_value (hint_t object_type, uint16_t x, uint16_t y, uint16_t z, uint32_t val)
	Set a value in a certain histogram.
Public Member Functions inherited from firevision::FireVisionDataFile
	FireVisionDataFile (unsigned short int magic_token, unsigned short int version)
	Constructor.
virtual	~FireVisionDataFile ()
	Destructor.
unsigned int	magic_token ()
	Get the magic token of the file.
unsigned int	version ()
	Get the version of the file.
bool	is_big_endian ()
	Check if data is encoded as big endian.
bool	is_little_endian ()
	Check if data is encoded as little endian.
size_t	num_blocks ()
	Get the number of available info blocks.
const char *	get_comment () const
	Get comment.
void	set_comment (const char *comment)
	Set comment.
void	set_owns_blocks (bool owns_blocks)
	Lets the file take over the ownership and give up the ownership of the blocks, respectively.
virtual void	add_block (FireVisionDataFileBlock *block)
	Add a block.
virtual void	clear ()
	Clear internal storage.
virtual void	write (const char *file_name)
	Write file.
virtual void	read (const char *file_name)
	Read file.
BlockList &	blocks ()
	Get blocks.

Additional Inherited Members
Static Public Member Functions inherited from firevision::FireVisionDataFile
static unsigned short int	read_magic_token (const char *filename)
	Get magic token from file.
static bool	has_magic_token (const char *filename, unsigned short int magic_token)
	Check if file has a certain magic token.
Protected Attributes inherited from firevision::FireVisionDataFile
void *	_spec_header
	Content specific header.
size_t	_spec_header_size
	Size in bytes of _spec_header.

---

Detailed Description

A fileformat for histograms.

Such a file might contain multiple histograms, each for a a different type of object.

Author:

Daniel Beck

Definition at line 42 of file histogram_file.h.

---

Member Typedef Documentation

typedef std::list<HistogramBlock*> firevision::HistogramFile::HistogramBlockList

Convenience typdef for a STL list of pointers to histogram blocks.

Definition at line 51 of file histogram_file.h.

---

Constructor & Destructor Documentation

firevision::HistogramFile::HistogramFile

(

)

Constructor.

Definition at line 42 of file histogram_file.cpp.

firevision::HistogramFile::~HistogramFile

(

)

Destructor.

Definition at line 50 of file histogram_file.cpp.

---

Member Function Documentation

void firevision::HistogramFile::add_histogram_block

(

HistogramBlock *

block

)

Adds a new histogram block to the file.

Parameters:

block

the histogram block

Definition at line 60 of file histogram_file.cpp.

References firevision::FireVisionDataFile::add_block(), and firevision::HistogramBlock::object_type().

Referenced by firevision::Histogram::save(), and firevision::BayesColormapGenerator::save_histograms().

uint32_t firevision::HistogramFile::get_value	(	hint_t	object_type,
		uint16_t	x,
		uint16_t	y,
		uint16_t	z
	)

Get a value from a certain histogram.

Parameters:

object_type	the requested value is obtained from the histogram for this type of object
x	the x-coordinate
y	the y-coordinate
z	the z-coordinate

Returns:

value

Definition at line 104 of file histogram_file.cpp.

HistogramFile::HistogramBlockList firevision::HistogramFile::histogram_blocks

(

)

Generates a list of histogram blocks attached to the file.

Returns:

a list of all attached histogram blocks

Definition at line 74 of file histogram_file.cpp.

References firevision::FireVisionDataFile::blocks().

Referenced by firevision::BayesColormapGenerator::load_histograms().

void firevision::HistogramFile::set_value	(	hint_t	object_type,
		uint16_t	x,
		uint16_t	y,
		uint16_t	z,
		uint32_t	val
	)

Set a value in a certain histogram.

Parameters:

object_type	this specifies the type for which the respective histogram is changed
x	the x-coordinate
y	the y-coordinate
z	the z-coordinate
val	the new value for the specified cell

Definition at line 122 of file histogram_file.cpp.

---

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

• src/libs/fvutils/statistical/histogram_file.h
• src/libs/fvutils/statistical/histogram_file.cpp