GeometricCalibration.h

// GeometricCalibration.h:
// -----------------------
//

#ifndef __IPSDKBASEDATA_GEOMETRICCALIBRATION_H__
#define __IPSDKBASEDATA_GEOMETRICCALIBRATION_H__

// suppression warnings
// warning C4251: 'ipsdk::GeometricCalibration::_unitStr': class 'std::basic_string<char,std::char_traits<char>,std::allocator<char>>' needs to have dll-interface to be used by clients of class 'ipsdk::GeometricCalibration'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseData/IPSDKBaseDataExports.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>
#include <IPSDKBaseData/Calibration/GeometricCalibrationTypes.h>

namespace ipsdk {


class IPSDKBASEDATA_API GeometricCalibration : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseData, GeometricCalibration)

public:
    GeometricCalibration();
    ~GeometricCalibration();

// methods
public:
    inline void                 init2d(const ipReal32 scale,
                                       const std::string& unitStr = "",
                                       const ipReal32 xOrigin = 0.f,
                                       const ipReal32 yOrigin = 0.f,
                                       const ipReal32 qr = 0.f,
                                       const ipReal32 qi = 0.f,
                                       const ipReal32 qj = 0.f);
    void                        init2d(const ipReal32 xScale,
                                       const ipReal32 yScale,
                                       const std::string& unitStr = "",
                                       const ipReal32 xOrigin = 0.f,
                                       const ipReal32 yOrigin = 0.f,
                                       const ipReal32 qr = 0.f,
                                       const ipReal32 qi = 0.f,
                                       const ipReal32 qj = 0.f);

    inline void                 init3d(const ipReal32 scale,
                                       const std::string& unitStr = "",
                                       const ipReal32 xOrigin = 0.f,
                                       const ipReal32 yOrigin = 0.f,
                                       const ipReal32 zOrigin = 0.f,
                                       const ipReal32 qr = 0.f,
                                       const ipReal32 qi = 0.f,
                                       const ipReal32 qj = 0.f,
                                       const ipReal32 qk = 0.f);
    void                        init3d(const ipReal32 xScale,
                                       const ipReal32 yScale,
                                       const ipReal32 zScale,
                                       const std::string& unitStr = "",
                                       const ipReal32 xOrigin = 0.f,
                                       const ipReal32 yOrigin = 0.f,
                                       const ipReal32 zOrigin = 0.f,
                                       const ipReal32 qr = 0.f,
                                       const ipReal32 qi = 0.f,
                                       const ipReal32 qj = 0.f,
                                       const ipReal32 qk = 0.f);

    inline ipReal32
    getXScale() const;

    inline ipReal32
    getYScale() const;

    inline ipReal32
    getZScale() const;

    inline const std::string&
    getUnitStr() const;

    inline ipReal32
    getXOrigin() const;

    inline ipReal32
    getYOrigin() const;

    inline ipReal32
    getZOrigin() const;

    inline ipReal32
    getXOriginUncalibrated() const;

    inline ipReal32
    getYOriginUncalibrated() const;

    inline ipReal32
    getZOriginUncalibrated() const;


    inline ipReal32
    getRotationQr() const;

    inline ipReal32
    getRotationQi() const;

    inline ipReal32
    getRotationQj() const;

    inline ipReal32
    getRotationQk() const;

    void setOrigin(const ipReal32 xOrigin, const ipReal32 yOrigin);
    void setOrigin(const ipReal32 xOrigin, const ipReal32 yOrigin, const ipReal32 zOrigin);

    void setUnitStr(const std::string& unitStr);

    void setScale(const ipReal32 scale, const std::string& unitStr);
    void setScale(const ipReal32 xScale, const ipReal32 yScale, const std::string& unitStr);
    void setScale(const ipReal32 xScale, const ipReal32 yScale, const ipReal32 zScale, const std::string& unitStr);

    bool                        operator== (const GeometricCalibration& calibration) const;
    bool                        operator!= (const GeometricCalibration& calibration) const;

// attributes
protected:
    ipReal32            _xScale;

    ipReal32            _yScale;

    ipReal32            _zScale;

    std::string         _unitStr;

    ipReal32            _xOrigin;

    ipReal32            _yOrigin;

    ipReal32            _zOrigin;

    RotationQuaternion  _rotation;
};


inline void
GeometricCalibration::init2d(const ipReal32 scale,
                             const std::string& unitStr,
                             const ipReal32 xOrigin,
                             const ipReal32 yOrigin,
                             const ipReal32 qr,
                             const ipReal32 qi,
                             const ipReal32 qj)
{
    init2d(scale, scale, unitStr, xOrigin, yOrigin, qr, qi, qj);
}

inline void
GeometricCalibration::init3d(const ipReal32 scale,
                             const std::string& unitStr,
                             const ipReal32 xOrigin,
                             const ipReal32 yOrigin,
                             const ipReal32 zOrigin,
                             const ipReal32 qr,
                             const ipReal32 qi,
                             const ipReal32 qj,
                             const ipReal32 qk)
{
    init3d(scale, scale, scale, unitStr, xOrigin, yOrigin, zOrigin, qr, qi, qj , qk);
}

inline ipReal32
GeometricCalibration::getXScale() const
{
    return _xScale;
}

inline ipReal32
GeometricCalibration::getYScale() const
{
    return _yScale;
}

inline ipReal32
GeometricCalibration::getZScale() const
{
    return _zScale;
}

inline const std::string&
GeometricCalibration::getUnitStr() const
{
    return _unitStr;
}

inline ipReal32
GeometricCalibration::getXOrigin() const
{
    return _xOrigin;
}

inline ipReal32
GeometricCalibration::getYOrigin() const
{
    return _yOrigin;
}

inline ipReal32
GeometricCalibration::getZOrigin() const
{
    return _zOrigin;
}

inline ipReal32
GeometricCalibration::getXOriginUncalibrated() const
{
    return _xOrigin / _xScale;
}

inline ipReal32
GeometricCalibration::getYOriginUncalibrated() const
{
    return _yOrigin / _yScale;
}

inline ipReal32
GeometricCalibration::getZOriginUncalibrated() const
{
    return _zOrigin / _zScale;
}

inline ipReal32
GeometricCalibration::getRotationQr() const
{
    return _rotation._qr;
}

inline ipReal32
GeometricCalibration::getRotationQi() const
{
    return _rotation._qi;
}

inline ipReal32
GeometricCalibration::getRotationQj() const
{
    return _rotation._qj;
}

inline ipReal32
GeometricCalibration::getRotationQk() const
{
    return _rotation._qk;
}


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_GEOMETRICCALIBRATION_H__