RectificationInfoFile Class Reference

Rectification Info File. More...

#include <fvutils/rectification/rectfile.h>

Inheritance diagram for RectificationInfoFile:

Inheritance graph
[legend]

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.
RectInfoBlockVector * rectinfo_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

Definition at line 33 of file rectfile.h.

Constructor & Destructor Documentation

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 77 of file rectfile.cpp.

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

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

Constructor.

Parameters:
cam_guid Camera globally unique identifier.
model String with the model name of the camera

Definition at line 58 of file rectfile.cpp.

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

RectificationInfoFile::~RectificationInfoFile (  ) 

Destructor.

Definition at line 93 of file rectfile.cpp.

Member Function Documentation

void 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:
block block to add

Definition at line 125 of file rectfile.cpp.

References FireVisionDataFile::add_block().

Referenced by TriclopsStereoProcessor::generate_rectification_lut().

uint64_t RectificationInfoFile::guid (  ) 

Get the GUID of camera.

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

Definition at line 103 of file rectfile.cpp.

References _rectinfo_header_t::guid.

Referenced by TriclopsStereoProcessor::verify_rectification_lut().

const char * RectificationInfoFile::model (  ) 

Get the model of the camera.

Returns:
string with the camera's model name

Definition at line 113 of file rectfile.cpp.

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

Read file.

Parameters:
file_name file to read from

Reimplemented from FireVisionDataFile.

Definition at line 154 of file rectfile.cpp.

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

Referenced by TriclopsStereoProcessor::verify_rectification_lut().

RectificationInfoFile::RectInfoBlockVector * RectificationInfoFile::rectinfo_blocks (  ) 

Get all rectification info blocks.

Returns:
reference to internal vector of rectinfo blocks.

Definition at line 135 of file rectfile.cpp.

References FireVisionDataFile::blocks().

Referenced by TriclopsStereoProcessor::verify_rectification_lut().

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