IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Member Functions | Friends | List of all members
ipsdk::shape::analysis::BaseGenericMeasure Class Referenceabstract

Base class for shape analysis generic measurement (generic measure using no input data for processing) More...

#include <BaseGenericMeasure.h>

Inheritance diagram for ipsdk::shape::analysis::BaseGenericMeasure:
ipsdk::shape::analysis::BaseMeasure ipsdk::BaseObjectWithSkeleton ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

virtual ~BaseGenericMeasure ()=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 BaseMeasureInfogetMeasureInfo () 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 GeometricCalibrationConstPtrgetGeometricCalibration () 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 eMsrProcessingStatusgetMsrProcessingStatus () const
 retrieve object status flag More...
 
bool hasMsrGlobalInfo () const
 check whether object is associated to global information More...
 
const MeasureGlobalInfogetMsrGlobalInfo () 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 BaseMeasureResultgetMeasureResult () const
 retrieve measure results More...
 
- Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzModegetSerializationMode () 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 BaseDynamicObjectcreateNew () 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 BaseDynamicObjectduplicate () 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

 BaseGenericMeasure ()
 constructor
 
virtual BoolResult measureShapeDerived (const ipUInt64 cPlanIdx, const ipUInt64 shapeIdx)=0
 process measure associated to a given shape 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 BaseMeasureResultaccessMeasureResult () const
 access to measure results in derived class More...
 
BaseMeasureResultaccessMeasureResult ()
 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 generic measurement (generic measure using no input data for processing)

Author
E. Noirfalise
Date
2015/06/30

Member Function Documentation

◆ isColorMsr()

bool ipsdk::shape::analysis::BaseGenericMeasure::isColorMsr ( ) const
virtual

check whether measure is a color measure

Exceptions
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisExceptionif isInit() == false

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

◆ measureShapeDerived()

virtual BoolResult ipsdk::shape::analysis::BaseGenericMeasure::measureShapeDerived ( const ipUInt64  cPlanIdx,
const ipUInt64  shapeIdx 
)
protectedpure virtual

process measure associated to a given shape

Parameters
cPlanIdxcurrent color plan index (0 in case of a grey level image)
shapeIdxindex of current processed shape
Returns
false in case of failure

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