Fawkes API  Fawkes Development Version
firevision::RectificationInfoFile Class Reference

Rectification Info File. More...

#include <>>

Inheritance diagram for firevision::RectificationInfoFile:

List of all members.

Classes

class  RectInfoBlockVector
 Vector that is used for maintaining the rectification info blocks. More...

Public Member Functions

 RectificationInfoFile ()
 Constructor.
 RectificationInfoFile (uint64_t cam_guid, const char *model)
 Constructor.
 ~RectificationInfoFile ()
 Destructor.
uint64_t guid ()
 Get the GUID of camera.
const char * model ()
 Get the model of the camera.
void add_rectinfo_block (RectificationInfoBlock *block)
 Add a rectification info block.
RectInfoBlockVectorrectinfo_blocks ()
 Get all rectification info blocks.
virtual void read (const char *filename)
 Read file.

Detailed Description

Rectification Info File.

This class provides access files that contain rectification info. Currently it supports writing and reading of such data and supports any number of rectificatoin info blocks (although this is limited by the file format!).

It follows the file format as defined in rectinfo.h. Files that are written are always of the current version. The endianess is automatically set to the current's system endianess.

Author:
Tim Niemueller

Constructor & Destructor Documentation

firevision::RectificationInfoFile::RectificationInfoFile ( )

Constructor.

This constructor may only be used for reading files, as the GUID of the camera is invalid for writing.

Definition at line 80 of file rectfile.cpp.

References firevision::FireVisionDataFile::_spec_header, firevision::FireVisionDataFile::_spec_header_size, firevision::_rectinfo_header_t::camera_model, and firevision::_rectinfo_header_t::guid.

firevision::RectificationInfoFile::RectificationInfoFile ( uint64_t  cam_guid,
const char *  model 
)

Constructor.

Parameters:
cam_guidCamera globally unique identifier.
modelString with the model name of the camera

Definition at line 61 of file rectfile.cpp.

References firevision::FireVisionDataFile::_spec_header, firevision::FireVisionDataFile::_spec_header_size, firevision::_rectinfo_header_t::camera_model, and firevision::_rectinfo_header_t::guid.

firevision::RectificationInfoFile::~RectificationInfoFile ( )

Destructor.

Definition at line 96 of file rectfile.cpp.


Member Function Documentation

void firevision::RectificationInfoFile::add_rectinfo_block ( RectificationInfoBlock block)

Add a rectification info block.

This instance takes over ownership of the rectinfo block. This means that the object is automatically deleted if this instance is deleted.

Parameters:
blockblock to add

Definition at line 128 of file rectfile.cpp.

References firevision::FireVisionDataFile::add_block().

Referenced by firevision::TriclopsStereoProcessor::generate_rectification_lut().

uint64_t firevision::RectificationInfoFile::guid ( )

Get the GUID of camera.

Returns:
GUID of the camera this rectification info file belongs to.

Definition at line 106 of file rectfile.cpp.

References firevision::_rectinfo_header_t::guid.

Referenced by firevision::TriclopsStereoProcessor::verify_rectification_lut().

const char * firevision::RectificationInfoFile::model ( )

Get the model of the camera.

Returns:
string with the camera's model name

Definition at line 116 of file rectfile.cpp.

void firevision::RectificationInfoFile::read ( const char *  file_name) [virtual]
RectificationInfoFile::RectInfoBlockVector * firevision::RectificationInfoFile::rectinfo_blocks ( )

Get all rectification info blocks.

Returns:
reference to internal vector of rectinfo blocks.

Definition at line 138 of file rectfile.cpp.

References firevision::FireVisionDataFile::blocks().

Referenced by firevision::TriclopsStereoProcessor::verify_rectification_lut().


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