mask.hpp

Go to the documentation of this file.

#ifndef ODP_MASK_HPP
#define ODP_MASK_HPP

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include <iostream>
#include "cpl_mask.h"
#include "cppcpl/error.hpp"

namespace odp {

  // forward declaration
  class Image;


  class  Mask: virtual public odp::Error
  {
  public:
   Mask();

    explicit Mask(cpl_size width, cpl_size height);

    explicit Mask(const Mask &mask);

    explicit Mask(const Mask &mask,
                  const cpl_size llx,
                  const cpl_size lly,
                  const cpl_size urx,
                  const cpl_size ury);

    explicit Mask(const Image &image);

    explicit Mask(const Image &image, double lo_cut, double hi_cut);

    virtual ~Mask();

    inline bool         IsMask()                   const;

    void                GetMaskPtr(void **data_ptr) const;

    inline void*        GetMaskPtr()               const;

    inline cpl_mask*    GetCplMask()               const;

    inline void         SetCplMask(cpl_mask *mask);

    inline cpl_size     GetWidth()                 const;

    inline cpl_size     GetHeight()                const;

    void Get(cpl_size  width,
             cpl_size  height,
             bool *value) const;

    bool Get(cpl_size  width,
             cpl_size  height) const;

    void Set(cpl_size  row,
             cpl_size  col,
             bool value);

    Mask& operator=(const Mask&) ;

    bool operator==(const Mask&) const;

    bool operator!=(const Mask&) const;

    friend std::ostream& operator<<(std::ostream &os, const Mask &mask);

  private:
    void Delete();

  protected:
    cpl_mask* m_cpl_mask;

  };
}

#include "mask.ipp"

#endif