cisst-saw
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
prmCameraInfo Class Reference

#include <prmCameraInfo.h>

Inheritance diagram for prmCameraInfo:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmCameraInfo (void)
 prmCameraInfo (const prmCameraInfo &other)
prmCameraInfo & operator= (const prmCameraInfo &other)
 ~prmCameraInfo ()
void GetWidth (size_t &placeHolder) const
size_t GetWidth (void) const
void SetWidth (const size_t &newValue)
const size_t & Width (void) const
size_t & Width (void)
void GetHeight (size_t &placeHolder) const
size_t GetHeight (void) const
void SetHeight (const size_t &newValue)
const size_t & Height (void) const
size_t & Height (void)
void GetDistortionParameters (vctDoubleVec &placeHolder) const
vctDoubleVec GetDistortionParameters (void) const
void SetDistortionParameters (const vctDoubleVec &newValue)
const vctDoubleVec & DistortionParameters (void) const
vctDoubleVec & DistortionParameters (void)
void GetIntrinsic (vct3x3 &placeHolder) const
vct3x3 GetIntrinsic (void) const
void SetIntrinsic (const vct3x3 &newValue)
const vct3x3 & Intrinsic (void) const
vct3x3 & Intrinsic (void)
void GetRectification (vctRot3 &placeHolder) const
vctRot3 GetRectification (void) const
void SetRectification (const vctRot3 &newValue)
const vctRot3 & Rectification (void) const
vctRot3 & Rectification (void)
void GetProjection (vct3x4 &placeHolder) const
vct3x4 GetProjection (void) const
void SetProjection (const vct3x4 &newValue)
const vct3x4 & Projection (void) const
vct3x4 & Projection (void)
void SerializeRaw (std::ostream &outputStream) const override
void DeSerializeRaw (std::istream &inputStream) override
void ToStream (std::ostream &outputStream) const override
void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
void Copy (const prmCameraInfo &source)
bool ScalarNumberIsFixed (void) const override
size_t ScalarNumber (void) const override
Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 mtsGenericObject (const mtsGenericObject &other)
virtual ~mtsGenericObject (void)
mtsGenericObject & operator= (const mtsGenericObject &other)
bool SetTimestampIfAutomatic (double timestamp)
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
virtual const cmnClassServicesBase * Services (void) const =0
bool ReconstructFrom (const cmnGenericObject &other)
std::string ToString (void) const
virtual cmnLogger::StreamBufType * GetLogMultiplexer (void) const
virtual double Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Public Attributes

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string SerializeDescription (const char delimiter=',', const std::string &userDescription="") const
void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string HumanReadable (void) const

Protected Attributes

size_t mWidth
size_t mHeight
vctDoubleVec mDistortionParameters
vct3x3 mIntrinsic
vctRot3 mRectification
vct3x4 mProjection

Constructor & Destructor Documentation

◆ prmCameraInfo() [1/2]

prmCameraInfo::prmCameraInfo ( void )

◆ prmCameraInfo() [2/2]

prmCameraInfo::prmCameraInfo ( const prmCameraInfo & other)

◆ ~prmCameraInfo()

prmCameraInfo::~prmCameraInfo ( )

Member Function Documentation

◆ Copy()

void prmCameraInfo::Copy ( const prmCameraInfo & source)

◆ DeSerializeRaw()

void prmCameraInfo::DeSerializeRaw ( std::istream & inputStream)
overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

◆ DistortionParameters() [1/2]

vctDoubleVec & prmCameraInfo::DistortionParameters ( void )

◆ DistortionParameters() [2/2]

const vctDoubleVec & prmCameraInfo::DistortionParameters ( void ) const

◆ GetDistortionParameters() [1/2]

void prmCameraInfo::GetDistortionParameters ( vctDoubleVec & placeHolder) const

◆ GetDistortionParameters() [2/2]

vctDoubleVec prmCameraInfo::GetDistortionParameters ( void ) const
inline

◆ GetHeight() [1/2]

void prmCameraInfo::GetHeight ( size_t & placeHolder) const

◆ GetHeight() [2/2]

size_t prmCameraInfo::GetHeight ( void ) const
inline

◆ GetIntrinsic() [1/2]

void prmCameraInfo::GetIntrinsic ( vct3x3 & placeHolder) const

◆ GetIntrinsic() [2/2]

vct3x3 prmCameraInfo::GetIntrinsic ( void ) const
inline

◆ GetProjection() [1/2]

void prmCameraInfo::GetProjection ( vct3x4 & placeHolder) const

◆ GetProjection() [2/2]

vct3x4 prmCameraInfo::GetProjection ( void ) const
inline

◆ GetRectification() [1/2]

void prmCameraInfo::GetRectification ( vctRot3 & placeHolder) const

◆ GetRectification() [2/2]

vctRot3 prmCameraInfo::GetRectification ( void ) const
inline

◆ GetWidth() [1/2]

void prmCameraInfo::GetWidth ( size_t & placeHolder) const

◆ GetWidth() [2/2]

size_t prmCameraInfo::GetWidth ( void ) const
inline

◆ Height() [1/2]

size_t & prmCameraInfo::Height ( void )

◆ Height() [2/2]

const size_t & prmCameraInfo::Height ( void ) const

◆ Intrinsic() [1/2]

vct3x3 & prmCameraInfo::Intrinsic ( void )

◆ Intrinsic() [2/2]

const vct3x3 & prmCameraInfo::Intrinsic ( void ) const

◆ operator=()

prmCameraInfo & prmCameraInfo::operator= ( const prmCameraInfo & other)

◆ Projection() [1/2]

vct3x4 & prmCameraInfo::Projection ( void )

◆ Projection() [2/2]

const vct3x4 & prmCameraInfo::Projection ( void ) const

◆ Rectification() [1/2]

vctRot3 & prmCameraInfo::Rectification ( void )

◆ Rectification() [2/2]

const vctRot3 & prmCameraInfo::Rectification ( void ) const

◆ ScalarNumber()

size_t prmCameraInfo::ScalarNumber ( void ) const
overridevirtual

Methods for data visualization. Derived classes should override the following methods in order to be properly processed by the data visualizer of the global component manager.

Return a number of data (which can be visualized, i.e., type-casted to double)

Reimplemented from mtsGenericObject.

◆ ScalarNumberIsFixed()

bool prmCameraInfo::ScalarNumberIsFixed ( void ) const
overridevirtual

Indicates if this object has a fixed number of scalars. This is used for arrays of object in order to optimize random access for a given scalar. When defining an object with a fixed number of scalars, overloading this method to return true allows some optimizations.

Reimplemented from mtsGenericObject.

◆ SerializeRaw()

void prmCameraInfo::SerializeRaw ( std::ostream & outputStream) const
overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetDistortionParameters()

void prmCameraInfo::SetDistortionParameters ( const vctDoubleVec & newValue)

◆ SetHeight()

void prmCameraInfo::SetHeight ( const size_t & newValue)

◆ SetIntrinsic()

void prmCameraInfo::SetIntrinsic ( const vct3x3 & newValue)

◆ SetProjection()

void prmCameraInfo::SetProjection ( const vct3x4 & newValue)

◆ SetRectification()

void prmCameraInfo::SetRectification ( const vctRot3 & newValue)

◆ SetWidth()

void prmCameraInfo::SetWidth ( const size_t & newValue)

◆ ToStream()

void prmCameraInfo::ToStream ( std::ostream & outputStream) const
overridevirtual

Human readable text output. This method only streams the data members of mtsGenericObject, i.e. the Timestamp and Valid flag. It should be called by any derived class re-implementing ToStream.

Reimplemented from mtsGenericObject.

◆ ToStreamRaw()

void prmCameraInfo::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
overridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ Width() [1/2]

size_t & prmCameraInfo::Width ( void )

◆ Width() [2/2]

const size_t & prmCameraInfo::Width ( void ) const

Member Data Documentation

◆ HumanReadable

void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string prmCameraInfo::HumanReadable(void) const

◆ mDistortionParameters

vctDoubleVec prmCameraInfo::mDistortionParameters
protected

◆ mHeight

size_t prmCameraInfo::mHeight
protected

◆ mIntrinsic

vct3x3 prmCameraInfo::mIntrinsic
protected

◆ mProjection

vct3x4 prmCameraInfo::mProjection
protected

◆ mRectification

vctRot3 prmCameraInfo::mRectification
protected

◆ mWidth

size_t prmCameraInfo::mWidth
protected

◆ SerializeDescription

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string prmCameraInfo::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const
The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0