Statistics3D.h

#pragma once
 
#include "DefinitionsThreeDim.h"
#include "AlgorithmFeature3D_SO.h"
 
#include "ReportDescriptorForStatistics3D.h"


namespace FLImaging
{
    namespace ThreeDim
    {
        class CInternalStatistics3D;

        class FL_EXPORT CStatistics3D : public CAlgorithmFeature3D_SO
        {
        public:

            enum EPointPosition
            {
                EPointPosition_X = 0,

                EPointPosition_Y,

                EPointPosition_Z,
            };

            enum EPointColor
            {
                EPointColor_B = 0,

                EPointColor_G,

                EPointColor_R,
            };

            CStatistics3D();

            CStatistics3D(const CStatistics3D& statistics3D);

            CStatistics3D(const CStatistics3D* pStatistics3D);

            virtual ~CStatistics3D();

            const CStatistics3D& operator=(const CStatistics3D& statistics3D);
 
            virtual const CResult SetSourceObject(Foundation::CFL3DObject* pFloSource) override;
            virtual const CResult SetSourceObject(Foundation::CFL3DObject& floSource) override;

            virtual const CResult Assign(const CStatistics3D& statistics3D);

            virtual const CResult Assign(const CStatistics3D* pStatistics3D);

            virtual const CResult Clear();

            virtual const CResult SetCorrelatedPointPosition(EPointPosition pointFirstPosition, EPointPosition pointSecondPosition);

            virtual const CResult GetCorrelatedPointPosition(EPointPosition& pointFirstPosition, EPointPosition& pointSecondPosition);
            
            virtual const CResult GetPointPositionMin(Base::TPoint3<double>& tpMin);

            virtual const CResult GetPointPositionMax(Base::TPoint3<double>& tpMax);

            virtual const CResult GetPointPositionSum(Base::TPoint3<double>& tpSum);

            virtual const CResult GetPointPositionSumOfSquares(Base::TPoint3<double>& tpSumOfSquares);

            virtual const CResult GetPointPositionMean(Base::TPoint3<double>& tpMean);

            virtual const CResult GetPointPositionMedian(Base::TPoint3<double>& tpMedian);

            virtual const CResult GetPointPositionLowerQuartile(Base::TPoint3<double>& tpLowerQuartile);

            virtual const CResult GetPointPositionUpperQuartile(Base::TPoint3<double>& tpUpperQuartile);

            virtual const CResult GetPointPositionVariance(Base::TPoint3<double>& tpVariance);

            virtual const CResult GetPointPositionStandardDeviation(Base::TPoint3<double>& tpStandardDeviation);

            virtual const CResult GetPointPositionCoefficientOfVariance(Base::TPoint3<double>& tpCoefficientOfVariance);

            virtual const CResult GetPointPositionCovariance(double& f64Covariance);

            virtual const CResult GetPointPositionCorrelationCoefficient(double& f64CorrelationCoefficient);

            virtual const CResult SetCorrelatedPointColor(EPointColor pointFirstColor, EPointColor pointSecondColor);

            virtual const CResult GetCorrelatedPointColor(EPointColor& pointFirstColor, EPointColor& pointSecondColor);

            virtual const CResult GetPointColorMin(Base::CMultiVar<double>& mvMin);

            virtual const CResult GetPointColorMax(Base::CMultiVar<double>& mvMax);

            virtual const CResult GetPointColorSum(Base::CMultiVar<double>& mvSum);

            virtual const CResult GetPointColorSumOfSquares(Base::CMultiVar<double>& mvSumOfSquares);

            virtual const CResult GetPointColorMean(Base::CMultiVar<double>& mvMean);

            virtual const CResult GetPointColorMedian(Base::CMultiVar<double>& mvMedian);

            virtual const CResult GetPointColorLowerQuartile(Base::CMultiVar<double>& mvLowerQuartile);

            virtual const CResult GetPointColorUpperQuartile(Base::CMultiVar<double>& mvUpperQuartile);

            virtual const CResult GetPointColorVariance(Base::CMultiVar<double>& mvVariance);

            virtual const CResult GetPointColorStandardDeviation(Base::CMultiVar<double>& mvStandardDeviation);

            virtual const CResult GetPointColorCoefficientOfVariance(Base::CMultiVar<double>& mvCoefficientOfVariance);

            virtual const CResult GetPointColorCovariance(double& f64Covariance);

            virtual const CResult GetPointColorCorrelationCoefficient(double& f64CorrelationCoefficient);

            virtual const CResult GetSurfaceArea(double& f64SurfaceArea);

            virtual const CResult EnablePreCalculatedHold(bool bPreCalculatedHold = false);

            virtual bool IsPreCalculatedHoldEnabled();
 
            virtual const CResult ReportToCSV(const Foundation::CReportDescriptor* pReportDescriptor) const override;

            virtual const CResult ReportToCSV(const ThreeDim::CReportDescriptorForStatistics3D& reportDescriptorForStatistics3D) const;

            virtual const CResult ReportToCSV(const ThreeDim::CReportDescriptorForStatistics3D* pReportDescriptorForStatistics3D) const;
 
            virtual bool IsLicenseAvailable() const override;
 
            DeclareGetClassType();
            SupportToDuplicateObject(CStatistics3D, *this);
 
        protected:

            EPointPosition m_pointFirstPosition;

            EPointPosition m_pointSecondPosition;

            EPointColor m_pointFirstColor;

            EPointColor m_pointSecondColor;

            bool m_bPreCalculatedHold;
 
        protected:
            CInternalStatistics3D* m_pInternal;
            friend class CInternalStatistics3D;
        };
    }
}