KernelXYZ.h

// KernelXYZ.h:
// ------------
//

#ifndef __IPSDKBASEDATA_KERNELXYZ_H__
#define __IPSDKBASEDATA_KERNELXYZ_H__

// suppression warnings
// warning C4251: 'ipsdk::KernelXYZ::_dataColl' : class 'std::map<_Kty,_Ty>' needs to have dll-interface to be used by clients of class 'ipsdk::KernelXYZ'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseData/Pattern/Kernel/BaseKernel.h>
#include <map>

namespace ipsdk {

class OffsetXYZ;


class IPSDKBASEDATA_API KernelXYZ : public BaseKernel
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseData, KernelXYZ)

// predefined public types
public:
    typedef OffsetXYZ OffsetType;

    typedef ipReal32 ValueType;

    typedef std::map<OffsetType, ValueType> DataColl;

public:
    KernelXYZ();
    ~KernelXYZ();

// methods
public:
    eKernelType         getKernelType() const;

    ipUInt32            getNbData() const;

    bool                exists(const OffsetType& offset) const;

    void                insert(const OffsetType& offset,
                               const ValueType& value);

    void                replace(const OffsetType& offset,
                                const ValueType& value);

    void                remove(const OffsetType& offset);

    void                multiply(const ValueType value);

    ValueType           getValue(const OffsetType& offset) const;

    const DataColl&     getDataColl() const;

    const ipUInt32      getSizeX() const;
    const ipUInt32      getSizeY() const;
    const ipUInt32      getSizeZ() const;

    const ipInt32       getMinX() const;
    const ipInt32       getMinY() const;
    const ipInt32       getMinZ() const;

    const ipInt32       getMaxX() const;
    const ipInt32       getMaxY() const;
    const ipInt32       getMaxZ() const;

    const ipUInt32      getStartingSizeX() const;
    const ipUInt32      getStartingSizeY() const;
    const ipUInt32      getStartingSizeZ() const;

    const ipUInt32      getEndingSizeX() const;
    const ipUInt32      getEndingSizeY() const;
    const ipUInt32      getEndingSizeZ() const;

    const ValueType     getCoefSum() const;

    const ValueType     getCoefAbsSum() const;

    // methods
protected:
    const ValueType computeAbsCoefSum();

    void                clear();

// attributes
protected:
    DataColl        _dataColl;

    ipInt32         _minX;
    ipInt32         _minY;
    ipInt32         _minZ;

    ipUInt32        _sizeX;
    ipUInt32        _sizeY;
    ipUInt32        _sizeZ;

    ValueType       _coefSum;
    ValueType       _absCoefSum;
};


inline eKernelType
KernelXYZ::getKernelType() const
{
    return eKernelType::eKT_XYZ;
}

inline const ipUInt32
KernelXYZ::getSizeX() const
{
    return _sizeX;
}

inline const ipUInt32
KernelXYZ::getSizeY() const
{
    return _sizeY;
}

inline const ipUInt32
KernelXYZ::getSizeZ() const
{
    return _sizeZ;
}

inline const ipInt32
KernelXYZ::getMinX() const
{
    return _minX;
}

inline const ipInt32
KernelXYZ::getMinY() const
{
    return _minY;
}

inline const ipInt32
KernelXYZ::getMinZ() const
{
    return _minZ;
}

inline const ipInt32
KernelXYZ::getMaxX() const
{
    if (_sizeX != 0)
        return _minX + static_cast<ipInt32>(_sizeX-1);
    else
        return 0;
}

inline const ipInt32
KernelXYZ::getMaxY() const
{
    if (_sizeY != 0)
        return _minY + static_cast<ipInt32>(_sizeY-1);
    else
        return 0;
}

inline const ipInt32
KernelXYZ::getMaxZ() const
{
    if (_sizeZ != 0)
        return _minZ + static_cast<ipInt32>(_sizeZ-1);
    else
        return 0;
}

inline const ipUInt32
KernelXYZ::getStartingSizeX() const
{
    if (_minX < 0)
        return static_cast<ipUInt32>(-_minX);
    else
        return 0;
}

inline const ipUInt32
KernelXYZ::getStartingSizeY() const
{
    if (_minY < 0)
        return static_cast<ipUInt32>(-_minY);
    else
        return 0;
}

inline const ipUInt32
KernelXYZ::getStartingSizeZ() const
{
    if (_minZ < 0)
        return static_cast<ipUInt32>(-_minZ);
    else
        return 0;
}

inline const ipUInt32
KernelXYZ::getEndingSizeX() const
{
    ipInt32 maxX = getMaxX();
    if (maxX > 0)
        return maxX;
    else
        return 0;
}

inline const ipUInt32
KernelXYZ::getEndingSizeY() const
{
    ipInt32 maxY = getMaxY();
    if (maxY > 0)
        return maxY;
    else
        return 0;
}

inline const ipUInt32
KernelXYZ::getEndingSizeZ() const
{
    ipInt32 maxZ = getMaxZ();
    if (maxZ > 0)
        return maxZ;
    else
        return 0;
}

inline const KernelXYZ::ValueType
KernelXYZ::getCoefSum() const
{
    return _coefSum;
}

inline const KernelXYZ::ValueType
KernelXYZ::getCoefAbsSum() const
{
    return _absCoefSum;
}


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_KERNELXYZ_H__