ipsdk::shape::analysis::MeasureGlobalInfo Class Reference

Predefined types for shape measurement operations global informations. More...

#include <MeasureGlobalInfo.h>

Inheritance diagram for ipsdk::shape::analysis::MeasureGlobalInfo:

Public Member Functions
bool	isInit () const
	check for object initialization
void	init (const image::ImageGeometryConstPtr &pImageGeometry, const Real64Vector &minGreyLevelColl, const Real64Vector &maxGreyLevelColl)
	initialization of object More...
const image::BaseImageGeometry &	getImageGeometry () const
	retrieve image geometry associated to object More...
bool	isValidCPlanIdx (const ipUInt64 cPlanIdx) const
	check whether a given color plan index is valid More...
const Real64Vector &	getMinGreyLevelColl () const
	retrieve minimum grey level collection for all color plans More...
const Real64Vector &	getMaxGreyLevelColl () const
	retrieve maximum grey level collection for all color plans More...
ipReal64	getMinGreyLevel (const ipUInt64 cPlanIdx=0) const
	retrieve minimum grey level for a given color image plan More...
ipReal64	getMaxGreyLevel (const ipUInt64 cPlanIdx=0) const
	retrieve maximum grey level for a given color image plan More...
void	clear ()
	clear of object data
Constructors and destructors
	MeasureGlobalInfo ()
	~MeasureGlobalInfo ()
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
image::ImageGeometryConstPtr	_pImageGeometry
	shared pointer to image geometry
Real64Vector	_minGreyLevelColl
	minimum grey level for image plan
Real64Vector	_maxGreyLevelColl
	maximum grey level for image plan
bool	_bInit
	object initialization flag

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

Predefined types for shape measurement operations global informations.

Author

E. Noirfalise

Date

2015/06/26

Copyright

2015 Reactiv'IP, all right reserved.

Member Function Documentation

init()

void ipsdk::shape::analysis::MeasureGlobalInfo::init	(	const image::ImageGeometryConstPtr &	pImageGeometry,
		const Real64Vector &	minGreyLevelColl,
		const Real64Vector &	maxGreyLevelColl
	)

initialization of object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if pImageGeometry.get() == 0
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if minGreyLevelColl.size() != pImageGeometry->getSizeC()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if maxGreyLevelColl.size() != pImageGeometry->getSizeC()

getImageGeometry()

const image::BaseImageGeometry& ipsdk::shape::analysis::MeasureGlobalInfo::getImageGeometry

(

)

const

retrieve image geometry associated to object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

isValidCPlanIdx()

bool ipsdk::shape::analysis::MeasureGlobalInfo::isValidCPlanIdx

(

const ipUInt64

cPlanIdx

)

const

check whether a given color plan index is valid

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getMinGreyLevelColl()

const Real64Vector& ipsdk::shape::analysis::MeasureGlobalInfo::getMinGreyLevelColl

(

)

const

retrieve minimum grey level collection for all color plans

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getMaxGreyLevelColl()

const Real64Vector& ipsdk::shape::analysis::MeasureGlobalInfo::getMaxGreyLevelColl

(

)

const

retrieve maximum grey level collection for all color plans

Exceptions

ipsdk::v::IPSDKBaseShapeAnalysisException

if isInit() == false

getMinGreyLevel()

ipReal64 ipsdk::shape::analysis::MeasureGlobalInfo::getMinGreyLevel

(

const ipUInt64

cPlanIdx = 0

)

const

retrieve minimum grey level for a given color image plan

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isValidCPlanIdx(cPlanIdx) == false

getMaxGreyLevel()

ipReal64 ipsdk::shape::analysis::MeasureGlobalInfo::getMaxGreyLevel

(

const ipUInt64

cPlanIdx = 0

)

const

retrieve maximum grey level for a given color image plan

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isValidCPlanIdx(cPlanIdx) == false

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseShapeAnalysis/Measure/GlobalInfo/MeasureGlobalInfo.h