Base class for shape analysis intensity measurement (geometry measure using image data for processing) More...

#include <BaseIntensityMeasure.h>

Inheritance diagram for ipsdk::shape::analysis::BaseIntensityMeasure:

Public Member Functions
virtual	~BaseIntensityMeasure ()=0
	destructor

bool	isColorMsr () const
	check whether measure is a color measure More...

Public Member Functions inherited from ipsdk::shape::analysis::BaseMeasure
virtual	~BaseMeasure ()=0
	destructor

bool	isInit () const
	check for object initialization

const BaseMeasureInfo &	getMeasureInfo () const
	retrieve measure information associated to measure More...

const std::string &	getToolTip () const
	retrieve object tool tip More...

const std::string &	getDefaultName () const
	retrieve default name associated to measure More...

const std::string &	getMeasureName () const
	retrieve name associated to measure More...

bool	is2dMode () const
	check whether measure is used in 2d mode More...

eMsrShapeRequirements	getMsrShapeRequirements () const
	retrieve shape data requirements associated to measure More...

bool	requiresRowIntersections () const

bool	requiresBoundaryApproximation () const

const GeometricCalibrationConstPtr &	getGeometricCalibration () const
	retrieve geometric calibration associated to measure More...

std::string	getMsrUnitStr () const
	retrieve formatted unit string associated to measure More...

eMsrProcessingPolicy	getMsrProcessingPolicy () const
	retrieve measure processing policy More...

bool	is2dMsr () const
	check whether measure can be used in 2d case More...

bool	is3dMsr () const
	check whether measure can be used in 3d case More...

ipReal32	getCalibrationXScale () const
	retrieve calibration scales associated to measure More...

ipReal32	getCalibrationYScale () const
	retrieve calibration scales associated to measure More...

ipReal32	getCalibrationZScale () const
	retrieve calibration scales associated to measure More...

const eMsrProcessingStatus &	getMsrProcessingStatus () const
	retrieve object status flag More...

bool	hasMsrGlobalInfo () const
	check whether object is associated to global information More...

const MeasureGlobalInfo &	getMsrGlobalInfo () const
	retrieve global information associated to measure More...

ipUInt64	getNbColorPlans () const
	retrieve number of color plans associated to measure More...

ipUInt64	getNbEntities () const
	retrieve number of entities associated to measure More...

bool	isReadyToProcess () const
	check whether measure is ready to process (which means that processing of all dependencies is ended) More...

const BaseMeasureResult &	getMeasureResult () const
	retrieve measure results More...

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const
	retrieve serialization flag for object More...

void	setSerializationMode (const eSklSrzMode &sklSrzMode) const
	set serialization flag for object

	BaseObjectWithSkeleton ()

	~BaseObjectWithSkeleton ()

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 Member Functions
	BaseIntensityMeasure ()
	constructor

virtual BoolResult	startShapeMeasuresDerived (const ipUInt64 shapeIdx)
	start an intensity measure processing for a given shape More...

virtual BoolResult	measureShapeDerived (const ipUInt64 cPlanIdx, const ipUInt64 shapeIdx, const geom::RowSegments &rowSegments, const image::eImageBufferType &imageBufferType, const ipUInt64 rowIdx, const ipUInt64 zPlanIdx, const void *pBuf)=0
	process all measures associated to a given shape and a row index More...

virtual BoolResult	endShapeMeasuresDerived (const ipUInt64 shapeIdx)
	end an intensity measure processing for a given shape More...

virtual BoolResult	collectResultsDerived (const UInt64Vector &resultIndexColl, const BaseMeasure &subMeasure)=0
	collect results of a measure from results index collection More...

Protected Member Functions inherited from ipsdk::shape::analysis::BaseMeasure
	BaseMeasure ()
	constructor

virtual MeasureResultPtr	startProcessingDerived (const ipUInt64 defaultNbColorPlans, const ipUInt64 nbEntities, const bool bForceNbColorPlans, const bool bWithIgnoredFirstElement)=0
	method allowing to start processing and create a measure result in derived class

virtual BoolResult	validateMsrParams (const DataItemConstPtr &pMeasureParams) const
	method allowing to validate measure parameters in derived class

MeasureConstPtr	getDependency (const std::string &dependencyName) const
	retrieve measure dependency More...

virtual bool	hasColorDependency () const
	method allowing to test whether measure has some color dependencies

virtual void	copyAdditionalResults (const BaseMeasure &subMeasure)
	copy additionnal results from derived class while creating a sub measure

virtual void	clearProcessingDerived ()
	method allowing to clear processing data in derived class

const BaseMeasureResult &	accessMeasureResult () const
	access to measure results in derived class More...

BaseMeasureResult &	accessMeasureResult ()
	access to measure results in derived class More...

virtual void	endProcessingDerived ()
	end measure processing in derived class

virtual void	endProcessingDerived (const geom::Shape2dConstVector &shape2dColl)
	end measure processing in derived class

virtual void	endProcessingDerived (const geom::Shape3dConstVector &shape3dColl)
	end measure processing in derived 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

Friends
class	MeasureSet

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 Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

Detailed Description

Base class for shape analysis intensity measurement (geometry measure using image data for processing)

Author: E. Noirfalise

Date: 2015/06/30

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ isColorMsr()

bool ipsdk::shape::analysis::BaseIntensityMeasure::isColorMsr ( ) const

virtual

check whether measure is a color measure

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

Implements ipsdk::shape::analysis::BaseMeasure.

◆ startShapeMeasuresDerived()

virtual BoolResult ipsdk::shape::analysis::BaseIntensityMeasure::startShapeMeasuresDerived ( const ipUInt64 shapeIdx )

inlineprotectedvirtual

start an intensity measure processing for a given shape

Parameters

shapeIdx index of current processed shape

Returns: false in case of failure

◆ measureShapeDerived()

virtual BoolResult ipsdk::shape::analysis::BaseIntensityMeasure::measureShapeDerived	(	const ipUInt64	cPlanIdx,
		const ipUInt64	shapeIdx,
		const geom::RowSegments &	rowSegments,
		const image::eImageBufferType &	imageBufferType,
		const ipUInt64	rowIdx,
		const ipUInt64	zPlanIdx,
		const void *	pBuf
	)

protectedpure virtual

process all measures associated to a given shape and a row index

Parameters

cPlanIdx	current color plan index (0 in case of a grey level image)
shapeIdx	index of current processed shape
rowSegments	segment collection associated to shape/row intersection
imageBufferType	image buffer type for operation
rowIdx	current row index for processing
zPlanIdx	current z plan index for processing
pBuf	current row data pointer

Returns: false in case of failure

◆ endShapeMeasuresDerived()

virtual BoolResult ipsdk::shape::analysis::BaseIntensityMeasure::endShapeMeasuresDerived ( const ipUInt64 shapeIdx )

inlineprotectedvirtual

end an intensity measure processing for a given shape

Parameters

shapeIdx index of current processed shape

Returns: false in case of failure

◆ collectResultsDerived()

virtual BoolResult ipsdk::shape::analysis::BaseIntensityMeasure::collectResultsDerived	(	const UInt64Vector &	resultIndexColl,
		const BaseMeasure &	subMeasure
	)

protectedpure virtual

collect results of a measure from results index collection

Parameters

resultIndexColl	result index collection of already processed data
subMeasure	measure containing collected (already processed) data

Warning: their is no check on results index validity

Returns: false in case of failure

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/BaseIntensityMeasure.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ isColorMsr()

◆ startShapeMeasuresDerived()

◆ measureShapeDerived()

◆ endShapeMeasuresDerived()

◆ collectResultsDerived()