Class allowing to encapsulate an image geometric calibration. More...

#include <GeometricCalibration.h>

Inheritance diagram for ipsdk::GeometricCalibration:

Public Member Functions
ipReal32	getXScale () const

ipReal32	getYScale () const

ipReal32	getZScale () const

const std::string &	getUnitStr () const
	retrieve unit associated to length measurement

ipReal32	getXOrigin () const

ipReal32	getYOrigin () const

ipReal32	getZOrigin () const

ipReal32	getXOriginUncalibrated () const

ipReal32	getYOriginUncalibrated () const

ipReal32	getZOriginUncalibrated () const

ipReal32	getRotationQr () const
	retrieve the real quaternion rotation component

ipReal32	getRotationQi () const
	retrieve the i quaternion rotation component

ipReal32	getRotationQj () const
	retrieve the j quaternion rotation component

ipReal32	getRotationQk () const
	retrieve the k quaternion rotation component

void	setUnitStr (const std::string &unitStr)
	Setter to change the unit string.

Constructors and destructor
	GeometricCalibration ()

	~GeometricCalibration ()


void	init2d (const ipReal32 scale, const std::string &unitStr="", const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f)
	initialization of a 2d image geometric calibration More...

void	init2d (const ipReal32 xScale, const ipReal32 yScale, const std::string &unitStr="", const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f)
	initialization of a 2d image geometric calibration More...


void	init3d (const ipReal32 scale, const std::string &unitStr="", const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 zOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f, const ipReal32 qk=0.f)
	initialization of a 3d image geometric calibration More...

void	init3d (const ipReal32 xScale, const ipReal32 yScale, const ipReal32 zScale, const std::string &unitStr="", const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 zOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f, const ipReal32 qk=0.f)
	initialization of a 3d image geometric calibration More...


void	setOrigin (const ipReal32 xOrigin, const ipReal32 yOrigin)

void	setOrigin (const ipReal32 xOrigin, const ipReal32 yOrigin, const ipReal32 zOrigin)


void	setScale (const ipReal32 scale, const std::string &unitStr)

void	setScale (const ipReal32 xScale, const ipReal32 yScale, const std::string &unitStr)

void	setScale (const ipReal32 xScale, const ipReal32 yScale, const ipReal32 zScale, const std::string &unitStr)


bool	operator== (const GeometricCalibration &calibration) const
	comparison operators

bool	operator!= (const GeometricCalibration &calibration) const
	comparison operators

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Protected Attributes
ipReal32	_xScale

ipReal32	_yScale

ipReal32	_zScale

std::string	_unitStr
	unit associated to length measurement

ipReal32	_xOrigin

ipReal32	_yOrigin

ipReal32	_zOrigin

RotationQuaternion	_rotation

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Detailed Description

Class allowing to encapsulate an image geometric calibration.

Author: E. Noirfalise

Date: 2017/09/21

Copyright: 2017 Reactiv'IP, all right reserved.

Member Function Documentation

◆ init2d() [1/2]

void ipsdk::GeometricCalibration::init2d	(	const ipReal32	scale,
		const std::string &	unitStr = `""`,
		const ipReal32	xOrigin = `0.f`,
		const ipReal32	yOrigin = `0.f`,
		const ipReal32	qr = `0.f`,
		const ipReal32	qi = `0.f`,
		const ipReal32	qj = `0.f`
	)

inline

initialization of a 2d image geometric calibration

Exceptions

ipsdk::IPSDKBaseDataException if scale <= 0

◆ init2d() [2/2]

void ipsdk::GeometricCalibration::init2d	(	const ipReal32	xScale,
		const ipReal32	yScale,
		const std::string &	unitStr = `""`,
		const ipReal32	xOrigin = `0.f`,
		const ipReal32	yOrigin = `0.f`,
		const ipReal32	qr = `0.f`,
		const ipReal32	qi = `0.f`,
		const ipReal32	qj = `0.f`
	)

initialization of a 2d image geometric calibration

Exceptions

ipsdk::IPSDKBaseDataException if scale <= 0

◆ init3d() [1/2]

void ipsdk::GeometricCalibration::init3d	(	const ipReal32	scale,
		const std::string &	unitStr = `""`,
		const ipReal32	xOrigin = `0.f`,
		const ipReal32	yOrigin = `0.f`,
		const ipReal32	zOrigin = `0.f`,
		const ipReal32	qr = `0.f`,
		const ipReal32	qi = `0.f`,
		const ipReal32	qj = `0.f`,
		const ipReal32	qk = `0.f`
	)

inline

initialization of a 3d image geometric calibration

Exceptions

ipsdk::IPSDKBaseDataException if scale <= 0

◆ init3d() [2/2]

void ipsdk::GeometricCalibration::init3d	(	const ipReal32	xScale,
		const ipReal32	yScale,
		const ipReal32	zScale,
		const std::string &	unitStr = `""`,
		const ipReal32	xOrigin = `0.f`,
		const ipReal32	yOrigin = `0.f`,
		const ipReal32	zOrigin = `0.f`,
		const ipReal32	qr = `0.f`,
		const ipReal32	qi = `0.f`,
		const ipReal32	qj = `0.f`,
		const ipReal32	qk = `0.f`
	)

initialization of a 3d image geometric calibration

Exceptions

ipsdk::IPSDKBaseDataException if scale <= 0

◆ getXScale()

ipReal32 ipsdk::GeometricCalibration::getXScale ( ) const

inline

retrieve x scale for pixels/voxels (ie the real size of a pixel/voxels along x axis)

◆ getYScale()

ipReal32 ipsdk::GeometricCalibration::getYScale ( ) const

inline

retrieve y scale for pixels/voxels (ie the real size of a pixel/voxels along y axis)

◆ getZScale()

ipReal32 ipsdk::GeometricCalibration::getZScale ( ) const

inline

retrieve z scale for pixels/voxels (ie the real size of a pixel/voxels along z axis)

◆ getXOrigin()

ipReal32 ipsdk::GeometricCalibration::getXOrigin ( ) const

inline

retrieve the calibrated image origin position (along x axis)

◆ getYOrigin()

ipReal32 ipsdk::GeometricCalibration::getYOrigin ( ) const

inline

retrieve the calibrated image origin position (along y axis)

◆ getZOrigin()

ipReal32 ipsdk::GeometricCalibration::getZOrigin ( ) const

inline

retrieve the calibrated image origin position (along z axis)

◆ getXOriginUncalibrated()

ipReal32 ipsdk::GeometricCalibration::getXOriginUncalibrated ( ) const

inline

retrieve the non-calibrated image origin position (along x axis)

◆ getYOriginUncalibrated()

ipReal32 ipsdk::GeometricCalibration::getYOriginUncalibrated ( ) const

inline

retrieve the non-calibrated image origin position (along y axis)

◆ getZOriginUncalibrated()

ipReal32 ipsdk::GeometricCalibration::getZOriginUncalibrated ( ) const

inline

retrieve the non-calibrated image origin position (along z axis)

◆ setOrigin() [1/2]

void ipsdk::GeometricCalibration::setOrigin	(	const ipReal32	xOrigin,
		const ipReal32	yOrigin
	)

Setters to change the origin

◆ setOrigin() [2/2]

void ipsdk::GeometricCalibration::setOrigin	(	const ipReal32	xOrigin,
		const ipReal32	yOrigin,
		const ipReal32	zOrigin
	)

Setters to change the origin

◆ setScale() [1/3]

void ipsdk::GeometricCalibration::setScale	(	const ipReal32	scale,
		const std::string &	unitStr
	)

Change the scales and adjusts the origins

◆ setScale() [2/3]

void ipsdk::GeometricCalibration::setScale	(	const ipReal32	xScale,
		const ipReal32	yScale,
		const std::string &	unitStr
	)

Change the scales and adjusts the origins

◆ setScale() [3/3]

void ipsdk::GeometricCalibration::setScale	(	const ipReal32	xScale,
		const ipReal32	yScale,
		const ipReal32	zScale,
		const std::string &	unitStr
	)

Change the scales and adjusts the origins

Member Data Documentation

◆ _xScale

ipReal32 ipsdk::GeometricCalibration::_xScale

protected

x scale for pixels/voxels (ie the real size of a pixel/voxels along x axis)

◆ _yScale

ipReal32 ipsdk::GeometricCalibration::_yScale

protected

y scale for pixels/voxels (ie the real size of a pixel/voxels along y axis)

◆ _zScale

ipReal32 ipsdk::GeometricCalibration::_zScale

protected

z scale for pixels/voxels (ie the real size of a pixel/voxels along z axis)

◆ _xOrigin

ipReal32 ipsdk::GeometricCalibration::_xOrigin

protected

calibrated image origin position (along the x-axis) This is used when extracting a sub image from a global image

◆ _yOrigin

ipReal32 ipsdk::GeometricCalibration::_yOrigin

protected

calibrated image origin position (along the y-axis) This is used when extracting a sub image from a global image

◆ _zOrigin

ipReal32 ipsdk::GeometricCalibration::_zOrigin

protected

calibrated image origin position (along the z-axis) This is used when extracting a sub image from a global image

◆ _rotation

RotationQuaternion ipsdk::GeometricCalibration::_rotation

protected

Rotation of the image according to a global from which it has been extracted

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseData/Calibration/GeometricCalibration.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ init2d() [1/2]

◆ init2d() [2/2]

◆ init3d() [1/2]

◆ init3d() [2/2]

◆ getXScale()

◆ getYScale()

◆ getZScale()

◆ getXOrigin()

◆ getYOrigin()

◆ getZOrigin()

◆ getXOriginUncalibrated()

◆ getYOriginUncalibrated()

◆ getZOriginUncalibrated()

◆ setOrigin() [1/2]

◆ setOrigin() [2/2]

◆ setScale() [1/3]

◆ setScale() [2/3]

◆ setScale() [3/3]

Member Data Documentation

◆ _xScale

◆ _yScale

◆ _zScale

◆ _xOrigin

◆ _yOrigin

◆ _zOrigin

◆ _rotation