LineGauge.h

#pragma once

 
#include "DefinitionsAdvancedFunctions.h"

namespace FLImaging
{
    namespace AdvancedFunctions
    {
        class CInternalLineGauge;
        class CInternalLineGapDetector;

        class FL_EXPORT CLineGauge : public ImageProcessing::CAlgorithmFeature_SR
        {
        public:

            enum ETransitionType
            {
                ETransitionType_DarkToBright = 0x01,

                ETransitionType_BrightToDark = 0x02,

                ETransitionType_DarkToBrightOrBrightToDark = 0x04,

                ETransitionType_DarkToBrightToDark = 0x08,

                ETransitionType_BrightToDarkToBright = 0x10,

                ETransitionType_DarkToBrightToDarkOrBrightToDarkToBright = 0x20,
            };

            enum ETransitionChoice
            {
                ETransitionChoice_Begin = 0x10000,
                ETransitionChoice_End = 0x20000,
                ETransitionChoice_Closest = 0x40000,
                ETransitionChoice_LargestAmplitude = 0x80000,
                ETransitionChoice_LargestArea = 0x100000,
            };

            CLineGauge();

            CLineGauge(const CLineGauge& lg);

            CLineGauge(const CLineGauge* pLg);

            virtual ~CLineGauge();

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

            virtual const CResult Assign(const CLineGauge& aib);
            virtual const CResult Assign(const CLineGauge* pAib);

            virtual const CResult Execute();

            virtual const CResult Clear();

            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int32_t>* pFlpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int32_t>& flpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int64_t>* pFlpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<int64_t>& flpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<float>* pFlpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<float>& flpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<double>* pFlpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLPoint<double>& flpRegion, double f64Length, double f64Angle, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int32_t>* pFllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int32_t>& fllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int64_t>* pFllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int64_t>& fllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<float>* pFllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<float>& fllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<double>* pFllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<double>& fllRegion, double f64Tolerance = 40.);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int32_t>* pFllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int32_t>& fllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int64_t>* pFllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<int64_t>& fllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<float>* pFllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<float>& fllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<double>* pFllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLLine<double>& fllRegion, double f64ToleranceLeft, double f64ToleranceRight);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int32_t>* pFlrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int32_t>& flrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int64_t>* pFlrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<int64_t>& flrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<float>* pFlrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<float>& flrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<double>* pFlrRegion);
            virtual const CResult SetMeasurementRegion(const Foundation::CFLRect<double>& flrRegion);
            virtual Foundation::CFLLine<double> GetMeasurementRegion() const;

            virtual const CResult SetTransitionType(ETransitionType eTransitionType = ETransitionType_DarkToBrightOrBrightToDark);
            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 const CResult GetTolerance(double& f64Left, double& f64Right) 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 Foundation::CFLLine<double> GetMeasuredObject(int64_t i64Index = 0) const;

            virtual const CResult GetMeasuredObject(Foundation::CFLLine<double>& fllMeasuredObject, int64_t i64Index = 0) const;

            virtual const CResult GetMeasuredObject(Foundation::CFLLine<double>* pFllMeasuredObject, int64_t i64Index = 0) const;

            virtual const CResult GetMeasuredValidPoints(Foundation::CFLFigureArray& flfaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredValidPoints(Foundation::CFLFigureArray* pFlfaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredValidPoints(Foundation::CFLPointArray& flpaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredValidPoints(Foundation::CFLPointArray* pFlpaResult, int64_t i64Index = 0) const;

            const CResult GetMeasuredTransitionOfValidPoints(Base::CFLArray<int32_t>& flaResult, int64_t i64Index = 0) const;
            const CResult GetMeasuredTransitionOfValidPoints(Base::CFLArray<int32_t>* pFlaResult, int64_t i64Index = 0) const;

            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLFigureArray& flfaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLFigureArray* pFlfaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLPointArray& flpaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredInvalidPoints(Foundation::CFLPointArray* pFlpaResult, int64_t i64Index = 0) const;

            const CResult GetMeasuredTransitionOfInvalidPoints(Base::CFLArray<int32_t>& flaResult, int64_t i64Index = 0) const;
            const CResult GetMeasuredTransitionOfInvalidPoints(Base::CFLArray<int32_t>* pFlaResult, int64_t i64Index = 0) const;

            virtual const CResult GetMeasuredPoints(Foundation::CFLFigureArray& flfaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredPoints(Foundation::CFLFigureArray* pFlfaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredPoints(Foundation::CFLPointArray& flpaResult, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredPoints(Foundation::CFLPointArray* pFlpaResult, int64_t i64Index = 0) const;

            const CResult GetMeasuredTransition(Base::CFLArray<int32_t>& flaResult, int64_t i64Index = 0) const;
            const CResult GetMeasuredTransition(Base::CFLArray<int32_t>* pFlaResult, int64_t i64Index = 0) const;

            virtual const CResult GetMeasuredScore(double* pF64Score, int64_t i64Index = 0) const;
            virtual const CResult GetMeasuredScore(double& f64Score, int64_t i64Index = 0) const;

            virtual const Foundation::CFLLine<double> GetMeasuredLine() 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(CLineGauge, *this);
 
        protected:
            double m_f64Threshold;

            double m_f64MinimumAmplitude;

            double m_f64SamplingStep;

            double m_f64OutliersThreshold;

            int64_t m_i64OutliersThresholdCount;

            int64_t m_i64Thickness;

            Foundation::CFLLine<double> m_fllMeasurementLine;

            double m_f64ToleranceLeft;

            double m_f64ToleranceRight;

            EGaugeOutlierFilteringMode m_eOutlierFilteringMode;

            ETransitionType m_eTransitionType;

            ETransitionChoice m_eTransitionChoice;

            bool m_bClusterMode;

            bool m_bEnable;

            bool m_bOptimalFitting;

            bool m_bAccurateMode;
 
        protected:
            friend class CInternalLineGauge;
            friend class CInternalLineGapDetector;
 
            CInternalLineGauge* m_pInternal;
        };
    }
}