FormulaTypes.h

Go to the documentation of this file.

// FormulaTypes.h:
// ---------------
//

#ifndef __IPSDKBASESHAPEANALYSIS_FORMULATYPES_H__
#define __IPSDKBASESHAPEANALYSIS_FORMULATYPES_H__

#include <IPSDKUtil/Tools/EnumMacros.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <IPSDKUtil/BaseTypes.h>
#include <boost/shared_ptr.hpp>
#include <boost/variant/variant.hpp>
#include <boost/function.hpp>
#include <vector>
#include <map>

namespace ipsdk {
namespace shape {
namespace analysis {

class FormulaManager;


IPSDK_ENUM(eMsrFormulaOperatorType,

    // unary arithmetical operators
    (eMFOT_UnaryPlus)       
    (eMFOT_UnaryMinus)      

    // unary logical operators
    (eMFOT_Not)             

    // binary arithmetical operators
    (eMFOT_Plus)            
    (eMFOT_Minus)           
    (eMFOT_Multiply)        
    (eMFOT_Divide)          
    (eMFOT_Power)           

    // binary logical operators
    (eMFOT_And)             
    (eMFOT_Or)              
    (eMFOT_Equal)           
    (eMFOT_NotEqual)        
    (eMFOT_Greater)         
    (eMFOT_GreaterOrEqual)  
    (eMFOT_Lower)           
    (eMFOT_LowerOrEqual)    
)


IPSDK_ENUM(eMsrFormulaUnaryArithmeticFunctionType,

    (eMFUAFT_Abs)       
    (eMFUAFT_Sqrt)      
    (eMFUAFT_Exp)       
    (eMFUAFT_Log)       

    (eMFUAFT_Cos)       
    (eMFUAFT_Sin)       
    (eMFUAFT_Tan)       

    (eMFUAFT_ACos)      
    (eMFUAFT_ASin)      
    (eMFUAFT_ATan)      

    (eMFUAFT_CosH)      
    (eMFUAFT_SinH)      
    (eMFUAFT_TanH)      
)

IPSDK_ENUM(eMsrFormulaBinaryArithmeticFunctionType,

    (eMFBAFT_ATan2)     
)

IPSDK_ENUM(eMsrFormulaGenericArithmeticFunctionType,

    (eMFGAFT_Min)       
    (eMFGAFT_Max)       
    (eMFGAFT_Sum)       
    (eMFGAFT_Mean)      
    (eMFGAFT_Median)    
    (eMFGAFT_StdDev)    
    (eMFGAFT_Variance)  
    (eMFGAFT_NormL1)    
    (eMFGAFT_NormL2)    
)

IPSDK_ENUM(eMsrFormulaCoupledArithmeticFunctionType,

    (eMFCAFT_Distance)      
)

IPSDK_ENUM(eMsrFormulaTernaryLogicFunctionType,

    (eMFTLFT_If)    
)


IPSDK_ENUM(eMsrFormulaReserved,
    
    // image size
    (eMFR_ImageSizeX)       
    (eMFR_ImageSizeY)       
    (eMFR_ImageSizeZ)       

    // image center
    (eMFR_ImageCenterX)     
    (eMFR_ImageCenterY)     
    (eMFR_ImageCenterZ)     

    // plan grey level extrema
    (eMFR_PlanMinGL)        
    (eMFR_PlanMaxGL)        
)


IPSDK_ENUM(eMsrFormulaResultType,

    (eMFRT_Logic)

    (eMFRT_Arithmetic)
)


IPSDK_ENUM(eFormulaEvaluationStatus,

    (eMES_Success)

    (eMES_Warning)

    (eMES_Failure)
)

typedef ProcessingResult<eFormulaEvaluationStatus> EvalStatus;


typedef boost::variant<ipBool, ipReal64> FormulaResult;


struct ImageConstantId
{
    eMsrFormulaReserved         _csteId;

    boost::optional<ipUInt32>   _colorIndex;
};


struct FormulaVariableId
{
    std::string                 _varName;

    boost::optional<ipUInt32>   _colorIndex;

    boost::optional<ipUInt32>   _arrayIndex;
};


typedef boost::shared_ptr<ipReal64> VariableValuePtr;


struct ImageConstant
{
    ImageConstantId             _id;

    VariableValuePtr            _pValue;
};

typedef std::map<ImageConstantId, VariableValuePtr> ConstantMap;


struct FormulaVariable
{
    FormulaVariableId           _id;

    VariableValuePtr            _pValue;
};

typedef std::map<FormulaVariableId, VariableValuePtr> VariableMap;


struct FormulaGenericArithmeticFunctionInfo
{
    eMsrFormulaGenericArithmeticFunctionType    _functionType;

    ipUInt32                                    _nbOperands;
};


struct FormulaCoupledArithmeticFunctionInfo
{
    eMsrFormulaCoupledArithmeticFunctionType    _functionType;

    ipUInt32                                    _nbOperands;
};



typedef boost::variant<ipBool,
                       ipReal64,
                       ImageConstant,
                       FormulaVariable,
                       eMsrFormulaOperatorType,
                       eMsrFormulaUnaryArithmeticFunctionType,
                       eMsrFormulaBinaryArithmeticFunctionType,
                       FormulaGenericArithmeticFunctionInfo,
                       FormulaCoupledArithmeticFunctionInfo,
                       eMsrFormulaTernaryLogicFunctionType
                      > FormulaItem;

typedef std::vector<FormulaItem> FormulaItemColl;


typedef boost::shared_ptr<FormulaManager> FormulaManagerPtr;


typedef boost::function1<bool, const ipUInt32> ResultsAccessor;

typedef std::vector<ResultsAccessor> ResultsAccessorColl;

typedef std::vector<ResultsAccessorColl> ColorResultsAccessorColl;


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

#endif // __IPSDKBASESHAPEANALYSIS_FORMULATYPES_H__