Blob.h

#pragma once

 
#include "DefinitionsAdvancedFunctions.h"
#include "ReportDescriptorForBlob.h"

namespace FLImaging
{
    namespace AI
    {
        class CInternalSegmentationRegionExtractor;
    }

    namespace AdvancedFunctions
    {
        class CInternalBlob;
        class CBlobSubsampled;
 
        template <typename dataType, typename maxType>
        class CInternalBlobTemplate;
 
        template <typename dataType, typename maxType>
        class CInternalBlobSubsampledTemplate;

        class FL_EXPORT CBlob : public ImageProcessing::CAlgorithmFeature_SR
        {
        public:
            enum EBlobResultType
            {
                EBlobResultType_Labeling = 0x00,
                EBlobResultType_BoundaryRect = 0x01,
                EBlobResultType_Contour = 0x02,
                EBlobResultType_MinimumEnclosingRectangle = 0x04,
                EBlobResultType_ConvexHull = 0x08,
                EBlobResultType_GravityCenter = 0x10,
                EBlobResultType_Circularity = 0x20,
                EBlobResultType_Area = 0x40,
                EBlobResultType_SolidArea = 0x80,
                EBlobResultType_Angle = 0x100,
            };

            enum EConnectedDirection
            {
                EConnectedDirection_Direction_4 = 0,
                EConnectedDirection_Direction_8,
            };

            enum EFilterItem
            {
                EFilterItem_Unselected = 0,
                EFilterItem_Area,
                EFilterItem_SolidArea,
                EFilterItem_Angle,
                EFilterItem_BoundaryRectCenterX,
                EFilterItem_BoundaryRectCenterY,
                EFilterItem_BoundaryRectWidth,
                EFilterItem_BoundaryRectHeight,
                EFilterItem_BoundaryRectWidthHeightRatio,
                EFilterItem_BoundaryRectShortLongRatio,
                EFilterItem_BoundaryRectLeft,
                EFilterItem_BoundaryRectTop,
                EFilterItem_BoundaryRectRight,
                EFilterItem_BoundaryRectBottom,
                EFilterItem_GravityCenterX,
                EFilterItem_GravityCenterY,
                EFilterItem_MinimumEnclosingRectangleCenterX,
                EFilterItem_MinimumEnclosingRectangleCenterY,
                EFilterItem_MinimumEnclosingRectanglePoint0X,
                EFilterItem_MinimumEnclosingRectanglePoint0Y,
                EFilterItem_MinimumEnclosingRectanglePoint1X,
                EFilterItem_MinimumEnclosingRectanglePoint1Y,
                EFilterItem_MinimumEnclosingRectanglePoint2X,
                EFilterItem_MinimumEnclosingRectanglePoint2Y,
                EFilterItem_MinimumEnclosingRectanglePoint3X,
                EFilterItem_MinimumEnclosingRectanglePoint3Y,
                EFilterItem_MinimumEnclosingRectangleLongSideLength,
                EFilterItem_MinimumEnclosingRectangleShortSideLength,
                EFilterItem_MinimumEnclosingRectangleShortLongRatio,
                EFilterItem_MinimumEnclosingRectangleArea,
                EFilterItem_Circularity,
                EFilterItem_Perimeter,
            };

            enum ESortClusterModeMethod
            {
                ESortClusterModeMethod_Center_Y_Asc_X_Asc = 0x100,
                ESortClusterModeMethod_Center_Y_Asc_X_Desc = 0x101,
                ESortClusterModeMethod_Center_Y_Desc_X_Asc = 0x102,
                ESortClusterModeMethod_Center_Y_Desc_X_Desc = 0x103,
                ESortClusterModeMethod_Center_X_Asc_Y_Asc = 0x110,
                ESortClusterModeMethod_Center_X_Asc_Y_Desc = 0x111,
                ESortClusterModeMethod_Center_X_Desc_Y_Asc = 0x112,
                ESortClusterModeMethod_Center_X_Desc_Y_Desc = 0x113,
                ESortClusterModeMethod_GravityCenter_Y_Asc_X_Asc = 0x200,
                ESortClusterModeMethod_GravityCenter_Y_Asc_X_Desc = 0x201,
                ESortClusterModeMethod_GravityCenter_Y_Desc_X_Asc = 0x202,
                ESortClusterModeMethod_GravityCenter_Y_Desc_X_Desc = 0x203,
                ESortClusterModeMethod_GravityCenter_X_Asc_Y_Asc = 0x210,
                ESortClusterModeMethod_GravityCenter_X_Asc_Y_Desc = 0x211,
                ESortClusterModeMethod_GravityCenter_X_Desc_Y_Asc = 0x212,
                ESortClusterModeMethod_GravityCenter_X_Desc_Y_Desc = 0x213,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_Y_Asc_X_Asc = 0x400,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_Y_Asc_X_Desc = 0x401,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_Y_Desc_X_Asc = 0x402,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_Y_Desc_X_Desc = 0x403,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_X_Asc_Y_Asc = 0x410,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_X_Asc_Y_Desc = 0x411,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_X_Desc_Y_Asc = 0x412,
                ESortClusterModeMethod_MinimumEnclosingRectangleCenter_X_Desc_Y_Desc = 0x413,
            };

            enum EOrder
            {
                EOrder_Ascending = 0,
                EOrder_Descending,
            };

            enum ELogicalConditionOfChannels
            {
                ELogicalConditionOfChannels_And = 0,
                ELogicalConditionOfChannels_Or
            };

            enum EContourResultType
            {
                EContourResultType_Solid = 0,
                EContourResultType_Perforated,
            };

            CBlob();
            CBlob(const CBlob& cc);
            CBlob(const CBlob* pCc);
            virtual ~CBlob();

            const CBlob& operator=(const CBlob& cc);

            virtual const CResult Assign(const CBlob& cc);
            virtual const CResult Assign(const CBlob* pCc);

            virtual const CResult SetThresholdMode(ImageProcessing::EThresholdMode eThresholdMode = ImageProcessing::EThresholdMode_Single);
            virtual ImageProcessing::EThresholdMode GetThresholdMode() const;

            virtual const CResult SetThreshold(double f64Threshold, ImageProcessing::EThresholdIndex eIndex = ImageProcessing::EThresholdIndex_First);
            virtual const CResult SetThreshold(double f64Threshold1, double f64Threshold2);
            virtual const CResult SetThreshold(const Base::CMultiVar<double>& mvThreshold = 127., ImageProcessing::EThresholdIndex eIndex = ImageProcessing::EThresholdIndex_First);
            virtual const CResult SetThreshold(const Base::CMultiVar<double>& mvThreshold1, const Base::CMultiVar<double>& mvThreshold2);

            virtual Base::CMultiVar<double> GetThreshold(ImageProcessing::EThresholdIndex eIndex = ImageProcessing::EThresholdIndex_First) const;
            virtual const CResult GetThreshold(double& f64Threshold) const;
            virtual const CResult GetThreshold(double& f64Threshold1, double& f64Threshold2) const;
            virtual const CResult GetThreshold(Base::CMultiVar<double>& mvThreshold) const;
            virtual const CResult GetThreshold(Base::CMultiVar<double>& mvThreshold1, Base::CMultiVar<double>& mvThreshold2) const;

            virtual const CResult EnabledAbsoluteMode(bool bAbsoluteMode = false);
            virtual bool IsAbsoluteModeEnabled() const;

            virtual const CResult SetLogicalConditionOfChannels(ELogicalConditionOfChannels eCondition = ELogicalConditionOfChannels_And);
            virtual ELogicalConditionOfChannels GetLogicalConditionOfChannels() const;

            virtual const CResult SetLogicalCondition(Base::ELogicalCondition eLogicalCondition = Base::ELogicalCondition_Greater, ImageProcessing::EThresholdIndex eIndex = ImageProcessing::EThresholdIndex_First);
            virtual const CResult SetLogicalCondition(Base::ELogicalCondition eLogicalCondition1, Base::ELogicalCondition eLogicalCondition2);
            virtual const CResult SetLogicalCondition(const Base::CMultiVar<int64_t>& mvLogicalCondition, ImageProcessing::EThresholdIndex eIndex = ImageProcessing::EThresholdIndex_First);
            virtual const CResult SetLogicalCondition(const Base::CMultiVar<int64_t>& mvLogicalCondition1, const Base::CMultiVar<int64_t>& mvLogicalCondition2);

            virtual const Base::CMultiVar<int64_t> GetLogicalCondition(ImageProcessing::EThresholdIndex eIndex = ImageProcessing::EThresholdIndex_First) const;
            virtual const CResult GetLogicalCondition(Base::ELogicalCondition& eLogicalCondition1, Base::ELogicalCondition& eLogicalCondition2) const;

            virtual const CResult SetResultType(EBlobResultType eType = EBlobResultType_BoundaryRect);
            virtual EBlobResultType GetResultType() const;

            virtual const CResult SetConnectedDirection(EConnectedDirection eDireciton = EConnectedDirection_Direction_8);
            virtual EConnectedDirection GetConnectedDirection() const;

            virtual const CResult SetContourResultType(EContourResultType eContourType = EContourResultType_Solid);
            virtual EContourResultType GetContourResultType() const;

            virtual const CResult GetResultLabelImage(Base::CFLImage& fliResultLabelImage) const;
            virtual const CResult GetResultLabelImage(Base::CFLImage* pFliResultLabelImage) const;

            virtual const CResult GetResultBlobImage(Base::CFLImage& fliResultBlobImage) const;
            virtual const CResult GetResultBlobImage(Base::CFLImage* pFliResultBlobImage) const;

            virtual const CResult GetResultBoundaryRects(Foundation::CFLFigureArray* pFlfaResultBoundaryRect) const;
            virtual const CResult GetResultBoundaryRects(Foundation::CFLFigureArray& flfaResultBoundaryRect) const;
            virtual const CResult GetResultBoundaryRect(int64_t i64Index, Foundation::CFLRect<int32_t>* pFlrResultBoundaryRect) const;
            virtual const CResult GetResultBoundaryRect(int64_t i64Index, Foundation::CFLRect<int32_t>& flrResultBoundaryRect) const;

            virtual const CResult GetResultContours(Foundation::CFLFigureArray* pFlfaResultContour) const;
            virtual const CResult GetResultContours(Foundation::CFLFigureArray& flfaResultContour) const;
            virtual const CResult GetResultContour(int64_t i64Index, Foundation::CFLRegion* pFlrgResultContour) const;
            virtual const CResult GetResultContour(int64_t i64Index, Foundation::CFLRegion& flrgResultContour) const;

            virtual const CResult GetResultPixelCenterContours(Foundation::CFLFigureArray* pFlfaResultContour) const;
            virtual const CResult GetResultPixelCenterContours(Foundation::CFLFigureArray& flfaResultContour) const;
            virtual const CResult GetResultPixelCenterContour(int64_t i64Index, Foundation::CFLRegion* pFlrgResultContour) const;
            virtual const CResult GetResultPixelCenterContour(int64_t i64Index, Foundation::CFLRegion& flrgResultContour) const;
            virtual const CResult GetResultMinimumEnclosingRectangles(Foundation::CFLFigureArray* pFlfaResultMER) const;
            virtual const CResult GetResultMinimumEnclosingRectangles(Foundation::CFLFigureArray& flfaResultMER) const;
            virtual const CResult GetResultMinimumEnclosingRectangle(int64_t i64Index, Foundation::CFLQuad<double>* pFlqResultMER) const;
            virtual const CResult GetResultMinimumEnclosingRectangle(int64_t i64Index, Foundation::CFLQuad<double>& flqResultMER) const;

            virtual const CResult GetResultConvexHulls(Foundation::CFLFigureArray* pFlfaResultConvex) const;
            virtual const CResult GetResultConvexHulls(Foundation::CFLFigureArray& flfaResultConvex) const;
            virtual const CResult GetResultConvexHull(int64_t i64Index, Foundation::CFLRegion* pFlrgResultConvex) const;
            virtual const CResult GetResultConvexHull(int64_t i64Index, Foundation::CFLRegion& flrgResultConvex) const;

            virtual const CResult GetResultCircularities(Base::CFLArray<double>* pFlaResultCircularities) const;
            virtual const CResult GetResultCircularities(Base::CFLArray<double>& flaResultCircularities) const;
            virtual const CResult GetResultCircularities(Base::CFLArray<Base::CFLArray<double>>* pFlaResultCircularities) const;
            virtual const CResult GetResultCircularities(Base::CFLArray<Base::CFLArray<double>>& flaResultCircularities) const;
            virtual const CResult GetResultCircularity(int64_t i64Index, double* pF64ResultCircularity) const;
            virtual const CResult GetResultCircularity(int64_t i64Index, double& f64ResultCircularity) const;

            virtual const CResult GetResultGravityCenters(Foundation::CFLFigureArray* pFlfaResultGravityCenters) const;
            virtual const CResult GetResultGravityCenters(Foundation::CFLFigureArray& flfaResultGravityCenters) const;
            virtual const CResult GetResultGravityCenter(int64_t i64Index, Foundation::CFLPoint<double>* pFlpResultGravityCenter) const;
            virtual const CResult GetResultGravityCenter(int64_t i64Index, Foundation::CFLPoint<double>& flpResultGravityCenter) const;

            virtual const CResult GetResultAreas(Base::CFLArray<uint64_t>* pFlaResultArea) const;
            virtual const CResult GetResultAreas(Base::CFLArray<uint64_t>& flaResultArea) const;
            virtual const CResult GetResultAreas(Base::CFLArray<Base::CFLArray<uint64_t>>* pFlaResultArea) const;
            virtual const CResult GetResultAreas(Base::CFLArray<Base::CFLArray<uint64_t>>& flaResultArea) const;
            virtual const CResult GetResultArea(int64_t i64Index, uint64_t* pU64ResultArea) const;
            virtual const CResult GetResultArea(int64_t i64Index, uint64_t& u64ResultArea) const;

            virtual const CResult GetResultSolidAreas(Base::CFLArray<uint64_t>* pFlaResultSolidArea) const;
            virtual const CResult GetResultSolidAreas(Base::CFLArray<uint64_t>& flaResultSolidArea) const;
            virtual const CResult GetResultSolidAreas(Base::CFLArray<Base::CFLArray<uint64_t>>* pFlaResultSolidArea) const;
            virtual const CResult GetResultSolidAreas(Base::CFLArray<Base::CFLArray<uint64_t>>& flaResultSolidArea) const;
            virtual const CResult GetResultSolidArea(int64_t i64Index, uint64_t* pU64ResultSolidArea) const;
            virtual const CResult GetResultSolidArea(int64_t i64Index, uint64_t& u64ResultSolidArea) const;

            virtual const CResult GetResultAngles(Base::CFLArray<float>* pFlaResultAngles) const;
            virtual const CResult GetResultAngles(Base::CFLArray<float>& flaResultAngles) const;
            virtual const CResult GetResultAngles(Base::CFLArray<Base::CFLArray<float>>* pFlaResultAngles) const;
            virtual const CResult GetResultAngles(Base::CFLArray<Base::CFLArray<float>>& flaResultAngles) const;
            virtual const CResult GetResultAngle(int64_t i64Index, float* pF32ResultAngle) const;
            virtual const CResult GetResultAngle(int64_t i64Index, float& f32ResultAngle) const;

            virtual const CResult Filter(EFilterItem eItem, double f64Value, Base::ELogicalCondition eCondition);
            virtual const CResult Sort(EFilterItem eItem = EFilterItem_Unselected, EOrder eOrder = EOrder_Ascending);
            virtual const CResult Sort(const Base::CFLArray<int32_t>& flaItem, const Base::CFLArray<int32_t>& flaOrder);

            virtual const CResult SortClusterMode(ESortClusterModeMethod eMethod = ESortClusterModeMethod_Center_Y_Asc_X_Asc, double f64Coefficient = .5);

            virtual const CResult Clear();

            virtual int64_t GetResultCount() const;

            virtual const CResult Execute();
 
 
            virtual const CResult ReportToCSV(const Foundation::CReportDescriptor* pRd) const override;

            virtual const CResult ReportToCSV(const CReportDescriptorForBlob& rd) const;
            virtual const CResult ReportToCSV(const CReportDescriptorForBlob* pRd) const;

            virtual const CResult SetFilterItem(CBlob::EFilterItem eFilterItem, double f64Value, Base::ELogicalCondition eFilterCondition);
            virtual const CResult AddFilterItem(CBlob::EFilterItem eFilterItem, double f64Value, Base::ELogicalCondition eFilterCondition);
            virtual const CResult SetFilterItem(const Base::CFLArray<int32_t>& flaFilterItem, const Base::CFLArray<double>& flaValue, const Base::CFLArray<int32_t>& flaFilterCondition);
            virtual const CResult AddFilterItem(const Base::CFLArray<int32_t>& flaFilterItem, const Base::CFLArray<double>& flaValue, const Base::CFLArray<int32_t>& flaFilterCondition);

            virtual const CResult GetFilterItem(CBlob::EFilterItem& eFilterItem, double& f64Value, Base::ELogicalCondition& eFilterCondition) const;
            virtual const CResult GetFilterItem(Base::CFLArray<int32_t>& flaFilterItem, Base::CFLArray<double>& flaValue, Base::CFLArray<int32_t>& flaFilterCondition) const;

            virtual const CResult ClearFilterItem();

            virtual const CResult SetSortItem(CBlob::EFilterItem eSortItem, CBlob::EOrder eOrder);
            virtual const CResult AddSortItem(CBlob::EFilterItem eSortItem, CBlob::EOrder eOrder);
            virtual const CResult SetSortItem(const Base::CFLArray<int32_t>& flaItem, const Base::CFLArray<int32_t>& flaOrder);
            virtual const CResult AddSortItem(const Base::CFLArray<int32_t>& flaItem, const Base::CFLArray<int32_t>& flaOrder);
            virtual const CResult GetSortItem(CBlob::EFilterItem& eSortItem, CBlob::EOrder& eOrder) const;
            virtual const CResult GetSortItem(Base::CFLArray<int32_t>& flaItem, Base::CFLArray<int32_t>& flaOrder) const;

            virtual const CResult SetSortClusterMode(CBlob::ESortClusterModeMethod eMethod, double f64Coefficient);
            virtual bool GetSortClusterMode(CBlob::ESortClusterModeMethod& eMethod, double& f64Coefficient) const;

            virtual const CResult ClearSortItem();

            virtual const CResult GetResultContourRasterRegions(Base::CFLArray<Base::CFLArray<Base::TRect<int32_t>>>* pFlaResults);
            virtual const CResult GetResultContourRasterRegions(Base::CFLArray<Base::CFLArray<Base::TRect<int32_t>>>& flaResults);
            virtual const CResult GetResultContourRasterRegions(Foundation::CFLFigureArray* pFlfaResults);
            virtual const CResult GetResultContourRasterRegions(Foundation::CFLFigureArray& flfaResults);
            virtual const CResult GetResultContourRasterRegion(int64_t i64Index, Base::CFLArray<Base::TRect<int32_t>>* pFlaResult);
            virtual const CResult GetResultContourRasterRegion(int64_t i64Index, Base::CFLArray<Base::TRect<int32_t>>& flaResult);
            virtual const CResult GetResultContourRasterRegion(int64_t i64Index, Foundation::CFLFigureArray* pFlfaResult);
            virtual const CResult GetResultContourRasterRegion(int64_t i64Index, Foundation::CFLFigureArray& flfaResult);
 
            virtual bool IsLicenseAvailable() const override;
 
 
            DeclareGetClassType();
            SupportToDuplicateObject(CBlob, *this);
 
        protected:

            ImageProcessing::EThresholdMode m_eThresholdMode;
            Base::CMultiVar<double> m_mvThreshold1;
            Base::CMultiVar<double> m_mvThreshold2;
            Base::CMultiVar<int64_t> m_mvLogicalCondition1;
            Base::CMultiVar<int64_t> m_mvLogicalCondition2;

            bool m_bAbsoluteMode;
            ELogicalConditionOfChannels m_eLogicalConditionOfChannels;

            EBlobResultType m_eType;
            EConnectedDirection m_eConnectedDirection;
            EContourResultType m_eContourType;

            Base::CFLArray<int32_t> m_flaFilterItem;
            Base::CFLArray<double> m_flaFilterValue;
            Base::CFLArray<int32_t> m_flaFilterCondition;

            Base::CFLArray<int32_t> m_flaSortItem;
            Base::CFLArray<int32_t> m_flaSortOrder;
            bool m_bSortClusterMode;
            CBlob::ESortClusterModeMethod m_eSortClusterMethod;
            double m_f64SortClusterCoefficient;
 
        protected:
            friend class CInternalBlob;
            friend class CBlobSubsampled;
            friend class CInternalBlobSubsampled;
            friend class CMura;
            friend class CInternalMura;
            friend class AI::CInternalSegmentationRegionExtractor;
 
            template<typename T1, typename T2> friend class CInternalBlobTemplate;
            template<typename T1, typename T2> friend class CInternalBlobSubsampledTemplate;
 
 
            CInternalBlob* m_pInternal;
        };
    }
}