MeasureSet.h

// MeasureSet.h:
// -------------
//

#ifndef __IPSDKBASESHAPEANALYSIS_MEASURESET_H__
#define __IPSDKBASESHAPEANALYSIS_MEASURESET_H__

// suppression warnings
// warning C4251: 'ipsdk::shape::analysis::MeasureSet::_measureColl' : class 'std::map<_Kty,_Ty>' needs to have dll-interface to be used by clients of class 'ipsdk::shape::analysis::MeasureSet'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseShapeAnalysis/IPSDKBaseShapeAnalysisExports.h>
#include <IPSDKBaseShapeAnalysis/Measure/MeasureTypes.h>
#include <IPSDKUtil/BaseCollections.h>
#include <IPSDKImage/Image/ImageTypes.h>
#include <IPSDKSerialization/Engine/BaseObjectWithSkeleton.h>
#include <boost/enable_shared_from_this.hpp>
#include <boost/smart_ptr/make_shared_object.hpp>

namespace ipsdk {
namespace shape {
namespace analysis {


class IPSDKBASESHAPEANALYSIS_API MeasureSet : public BaseObjectWithSkeleton,
                                              public boost::enable_shared_from_this<MeasureSet>
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKBaseShapeAnalysis, MeasureSet)

    // friend class for protected members access
    friend MeasureSetPtr boost::make_shared<MeasureSet>();

protected:
    MeasureSet();

public:
    ~MeasureSet();

// methods
public:
    static MeasureSetPtr                createMeasureSet(const MeasureInfoSetConstPtr& pMeasureInfoSet);

    ipUInt64                            getNbMeasure() const;

    ipUInt64                            getNbEntities() const;

    ipUInt64                            getNbColorPlans() const;

    const MeasureInfoSet&               getMeasureInfoSet() const;

    const MeasureColl&                  getMeasureColl() const;

    const GeometricCalibrationConstPtr& getGlobalGeometricCalibration() const;

    bool                                is2dMeasureSet() const;

    bool                                is3dMeasureSet() const;

    bool                                isMsrProcessingPolicy(const eMsrProcessingPolicy& msrProcessingPolicy) const;

    bool                                isProcessingStatus(const eMsrProcessingStatus& msrProcessingStatus) const;

    bool                                isReadyToProcess() const;

    MeasureConstPtr                     getMeasure(const std::string& measureName) const;
    const MeasurePtr&                   getMeasure(const std::string& measureName);

    BoolResult                          startProcessing(const ipUInt64 nbColorPlans,
                                                        const ipUInt64 nbEntities);

    void                                setMsrGlobalInfo(const eMsrInputImageId& msrInputImageId,
                                                         const MsrGlobalInfoConstPtr& pMsrGlobalInfo);

    bool                                hasMsrGlobalInfo(const eMsrInputImageId& msrInputImageId) const;

    const MeasureGlobalInfo&            getMsrGlobalInfo(const eMsrInputImageId& msrInputImageId) const;

    bool                                extractNextReadyMeasureSet(MeasureSetPtr& pSubMeasureSet,
                                                                   eMsrProcessingPolicy& msrProcessingPolicy,
                                                                   eMsrShapeRequirements& msrShapeRequirements,
                                                                   MeasureConfigConstPtr& pMeasureConfig);

    bool                                isStillNeeded(const eMsrInputShapeCollId& shapeCollId,
                                                      const GeometricCalibration& calibration) const;

    bool                                isStillNeeded(const eMsrInputImageId& imageId,
                                                      const BaseIntensityPreProcessorConfig& intensityPreProcessorConfig) const;

    MeasureSetPtr                       extractSubMeasureSet(const ipUInt64 subDataStartOffset,
                                                             const ipUInt64 nbSubData) const;
    MeasureSetPtr                       extractSubMeasureSet(const UInt64Vector& subDataIdxColl) const;

    BoolResult                          indivisibleMeasure();

    BoolResult                          genericMeasure(const ipUInt64 shapeIdx);

    void                                genericCollectResults(const ipUInt64 resultStartIndex,
                                                              const MeasureSet& subMeasureSet);

    BoolResult                          geometry2dMeasure(const ipUInt64 shapeIdx,
                                                          const geom::Shape2d& shape2d);

    void                                geometry2dCollectResults(const ipUInt64 resultStartIndex,
                                                                 const MeasureSet& subMeasureSet);

    BoolResult                          geometry3dMeasure(const ipUInt64 shapeIdx,
                                                          const geom::Shape3d& shape3d);

    void                                geometry3dCollectResults(const ipUInt64 resultStartIndex,
                                                                 const MeasureSet& subMeasureSet);


    BoolResult                          intensityStartShapeMeasures(const ipUInt64 shapeIdx);

    BoolResult                          intensityMeasure(const ipUInt64 cPlanIdx,
                                                         const ipUInt64 shapeIdx,
                                                         const geom::RowSegments& rowSegments,
                                                         const image::eImageBufferType& imageBufferType,
                                                         const ipUInt64 rowIdx,
                                                         const ipUInt64 zPlanIdx,
                                                         const void* pBuf);

    BoolResult                          intensityEndShapeMeasures(const ipUInt64 shapeIdx);

    BoolResult                          intensityCollectResults(const UInt64Vector& resultIndexColl,
                                                                const MeasureSet& subMeasureSet);

    void                                endProcessing(const geom::Shape2dConstVector& shape2dColl);

    void                                endProcessing(const geom::Shape3dConstVector& shape3dColl);

    void                                clearProcessing();

// attributes
protected:
    MeasureInfoSetConstPtr                              _pMeasureInfoSet;

    MeasureColl                                         _measureColl;

    ipUInt64                                            _nbEntities;
};


} // end of namespace analysis
} // end of namespace shape
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASESHAPEANALYSIS_MEASURESET_H__