FLImagingAdvancedFunctions/CrossGauge.h

#pragma once
 
#include "DefinitionsAdvancedFunctions.h"

 

namespace FLImaging
{
    namespace AdvancedFunctions
    {
        class CInternalCrossGauge;

        class FL_EXPORT CCrossGauge : public ImageProcessing::CAlgorithmFeature_SR
        {
        public:

            enum ETransitionType
            {
                ETransitionType_DarkToBrightToDark = 0x08,

                ETransitionType_BrightToDarkToBright = 0x10,

                ETransitionType_DarkToBrightToDarkOrBrightToDarkToBright = 0x20,
            };

            enum ETransitionChoice
            {
                ETransitionChoice_Closest = 0x40000,

                ETransitionChoice_LargestAmplitude = 0x80000,

                ETransitionChoice_LargestArea = 0x100000,
            };

            CCrossGauge();

            CCrossGauge(const CCrossGauge& lg);

            CCrossGauge(const CCrossGauge* pLg);

            virtual ~CCrossGauge();

            const CCrossGauge& operator=(const CCrossGauge& lg);

            virtual const CResult Assign(const CCrossGauge& aib);

            virtual const CResult Assign(const CCrossGauge* pAib);

            virtual const CResult Execute();

            virtual const CResult Clear();

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int32_t>& flpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int32_t>* pFlpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int64_t>& flpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int64_t>* pFlpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<float>& flpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<float>* pFlpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<double>& flpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<double>* pFlpRegion, double f64Width = 80., double f64Height = 80., double f64Angle = 0., double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int32_t>& flrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int32_t>* pFlrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int64_t>& flrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int64_t>* pFlrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<float>& flrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<float>* pFlrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<double>& flrRegion, double f64Tolerance = 40.);

            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<double>* pFlrRegion, double f64Tolerance = 40.);

            virtual Foundation::CFLRect<double> GetMeasurementRegion() const;

            virtual const CResult SetMeasurementMarginRatio(double f64InnerMargin = 0.3, double f64OuterMargin = 0.1);

            virtual const CResult GetMeasurementMarginRatio(double& f64InnerMargin, double& f64OuterMargin) const;

            virtual const CResult SetTransitionType(ETransitionType eTransitionType = ETransitionType_DarkToBrightToDarkOrBrightToDarkToBright);

            virtual ETransitionType GetTransitionType() const;

            virtual const CResult SetTransitionChoice(ETransitionChoice eTransitionChoice = ETransitionChoice_LargestAmplitude);

            virtual ETransitionChoice GetTransitionChoice() const;

            virtual const CResult SetThreshold(double f64Threshold = 20);

            virtual double GetThreshold() const;

            virtual const CResult SetMinimumAmplitude(double f64MinimumAmplitude = 10);

            virtual double GetMinimumAmplitude() const;

            virtual const CResult SetSamplingStep(double f64SamplingStep = 5.);

            virtual double GetSamplingStep() const;

            virtual const CResult EnableClusterMode(bool bEnable = true);

            virtual bool IsClusterModeEnabled() const;

            virtual const CResult SetOutlierFilteringMode(EGaugeOutlierFilteringMode eOutlierFilteringMode = EGaugeOutlierFilteringMode_Manual);
            virtual EGaugeOutlierFilteringMode GetOutlierFilteringMode() const;

            virtual const CResult SetOutliersThreshold(double f64OutliersThreshold = 3.);

            virtual double GetOutliersThreshold() const;

            virtual const CResult SetOutliersThresholdCount(int64_t i64OutliersThresholdCount = 3);

            virtual int64_t GetOutliersThresholdCount() const;

            virtual const CResult SetThickness(int64_t i64Thickness = 1);

            virtual int64_t GetThickness() const;

            virtual double GetTolerance() const;

            virtual const CResult EnableRegression(bool bEnable = true);

            virtual const bool IsRegressionEnabled() const;

            virtual const CResult EnableOptimalFitting(bool bEnable = true);

            virtual const bool IsOptimalFittingEnabled() const;

            virtual const CResult EnableAccurateMode(bool bAccurateMode = false);

            virtual bool IsAccurateModeEnabled() const;

            virtual const CResult GetMeasurementLines(Foundation::CFLFigureArray& flfaMeasuredLines) const;

            virtual const CResult GetMeasurementLines(Foundation::CFLFigureArray* pFlfaMeasuredLines) const;

            virtual const CResult GetMeasuredLines(Foundation::CFLFigureArray& flfaMeasuredLines) const;

            virtual const CResult GetMeasuredLines(Foundation::CFLFigureArray* pFlfaMeasuredLines) const;
          
            virtual const Foundation::CFLPoint<double> GetMeasuredObject() const;

            virtual const CResult GetMeasuredObject(Foundation::CFLPoint<double>& flpMeasuredObject) const;

            virtual const CResult GetMeasuredObject(Foundation::CFLPoint<double>* pFlpMeasuredObject) const;

            virtual const CResult GetMeasuredValidPoints(Foundation::CFLFigureArray& flfaResult) const;

            virtual const CResult GetMeasuredValidPoints(Foundation::CFLFigureArray* pFlfaResult) const;

            virtual const CResult GetMeasuredValidPoints(Foundation::CFLPointArray& flpaResult) const;

            virtual const CResult GetMeasuredValidPoints(Foundation::CFLPointArray* pFlpaResult) const;

            const CResult GetMeasuredTransitionOfValidPoints(Base::CFLArray<int32_t>& flaResult) const;
            const CResult GetMeasuredTransitionOfValidPoints(Base::CFLArray<int32_t>* pFlaResult) const;

            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLFigureArray& flfaResult) const;

            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLFigureArray* pFlfaResult) const;

            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLPointArray& flpaResult) const;

            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLPointArray* pFlpaResult) const;

            const CResult GetMeasuredTransitionOfInvalidPoints(Base::CFLArray<int32_t>& flaResult) const;
            const CResult GetMeasuredTransitionOfInvalidPoints(Base::CFLArray<int32_t>* pFlaResult) const;

            virtual const CResult GetMeasuredPoints(Foundation::CFLFigureArray& flfaResult) const;

            virtual const CResult GetMeasuredPoints(Foundation::CFLFigureArray* pFlfaResult) const;

            virtual const CResult GetMeasuredPoints(Foundation::CFLPointArray& flpaResult) const;

            virtual const CResult GetMeasuredPoints(Foundation::CFLPointArray* pFlpaResult) const;

            const CResult GetMeasuredTransition(Base::CFLArray<int32_t>& flaResult) const;
            const CResult GetMeasuredTransition(Base::CFLArray<int32_t>* pFlaResult) const;

            virtual const CResult GetMeasuredAngle(double* pF64Angle) const;

            virtual const CResult GetMeasuredAngle(double& f64Angle) const;
          
            virtual const CResult GetMeasuredScore(double* pF64Score) const;

            virtual const CResult GetMeasuredScore(double& f64Score) const;

            virtual const Foundation::CFLFigureArray GetActualMeasurementRegion();

            virtual const CResult GetMeasuredProfile(Base::CFLArray<double>& flaProfile, Base::CFLArray<double>& flaDerivative, double& f64MeasuredAverageDistance);
 
            virtual bool IsLicenseAvailable() const override;
 
 
            DeclareGetClassType();
            SupportToDuplicateObject(CCrossGauge, *this);
 
        protected:
            double m_f64Threshold;

            double m_f64MinimumAmplitude;

            double m_f64SamplingStep;

            double m_f64OutliersThreshold;

            int64_t m_i64OutliersThresholdCount;

            int64_t m_i64Thickness;

            Foundation::CFLRect<double> m_flrMeasurementLine;

            double m_f64Tolerance;

            EGaugeOutlierFilteringMode m_eOutlierFilteringMode;

            ETransitionType m_eTransitionType;

            ETransitionChoice m_eTransitionChoice;

            bool m_bClusterMode;

            double m_f64InnerMargin;

            double m_f64OuterMargin;

            bool m_bEnable;

            bool m_bOptimalFitting;

            bool m_bAccurateMode;
 
        protected:
            friend class CInternalCrossGauge;
            CInternalCrossGauge* m_pInternal;
        };
    }
}