StructuringElementXYZInfo.h

// StructuringElementXYZInfo.h:
// ----------------------------
//

#ifndef __IPSDKBASEDATA_STRUCTURINGELEMENTXYZINFO_H__
#define __IPSDKBASEDATA_STRUCTURINGELEMENTXYZINFO_H__

// suppression warnings
// warning C4251: 'ipsdk::StructuringElementXYZInfo::_seXYZSubType' : class 'ipsdk::eSEXYZSubType' needs to have dll-interface to be used by clients of class 'ipsdk::StructuringElementXYZInfo'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseData/Pattern/StructuringElement/BaseStructuringElementInfo.h>
#include <set>

namespace ipsdk {

class OffsetXYZ;


class IPSDKBASEDATA_API StructuringElementXYZInfo : public BaseStructuringElementInfo
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseData, StructuringElementXYZInfo)

public:
    StructuringElementXYZInfo();
    ~StructuringElementXYZInfo();

// methods
public:
    eStructuringElementType         getStructuringElementType() const;

    void                            init(const StructuringElementXYZ& seXYZ);

    void                            initEmpty();

    void                            initSpherical(const ipReal64 radius);

    void                            initCubic(const ipUInt32 halfSize);

    void                            initRectangular(const ipUInt32 halfSizeX,
                                                    const ipUInt32 halfSizeY,
                                                    const ipUInt32 halfSizeZ);

    void                            initHalfLinear(const ipReal64 theta,
                                                   const ipReal64 phi,
                                                   const ipReal64 radius);

    void                            initLinear(const ipReal64 theta,
                                               const ipReal64 phi,
                                               const ipReal64 radius);

    const eSEXYZSubType&            getSEXYZSubType() const;

    StructuringElementXYZConstPtr   getStructuringElement() const;

    ipReal64                        getRadius() const;

    ipUInt32                        getHalfSize() const;

    ipUInt32                        getHalfSizeX() const;
    ipUInt32                        getHalfSizeY() const;
    ipUInt32                        getHalfSizeZ() const;

    ipReal64                        getTheta() const;
    ipReal64                        getPhi() const;

    const XYZOffsetColl&            getDataColl() const;

    bool insert(const ipInt32 offsetX, const ipInt32 offsetY, const ipInt32 offsetZ);
    bool insert(const OffsetXYZ& offset);

    bool remove(const ipInt32 offsetX, const ipInt32 offsetY, const ipInt32 offsetZ);
    bool remove(const OffsetXYZ& offset);

protected:
    void            clearDerived();

// attributes
protected:
    eSEXYZSubType               _seXYZSubType;

    ipReal64                    _radius;

    ipUInt32                    _halfSize;

    ipUInt32                    _halfSizeX;
    ipUInt32                    _halfSizeY;
    ipUInt32                    _halfSizeZ;

    ipReal64                    _theta;
    ipReal64                    _phi;

    StructuringElementXYZPtr    _pSEXYZ;
};


inline eStructuringElementType
StructuringElementXYZInfo::getStructuringElementType() const
{
    return eStructuringElementType::eSET_XYZ;
}


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_STRUCTURINGELEMENTXYZINFO_H__