NoDataType.hpp

#pragma once
 
//OPALS
#include "opals/config.hpp"
#include "opals/CustomOptionType.hpp"
#include "opals/RasterDataType.hpp"
 
namespace opals {
 
  /// Class for storing a type independent a nodata value (nodata value can be deactivated as well)
  class OPALS_API NoDataType : public CustomOptionType<NoDataType>
  {
  public:
    enum Type
    {
      none = -1,  ///< deactivates the nodata value
      value,      ///< use the provided value 
      min,        ///< use the lowest value of the raster type as nodata value
      max,        ///< use the highest value of the raster type as nodata value
      nan,        ///< use Not-A-Number for floating-point and 'max' for integer raster types as nodata value
      bitmask     ///< use a separate bitmask as nodata information instead of a specific value
    };
 
  public:
    NoDataType();
    NoDataType(Type t);
    NoDataType(double v);
    virtual ~NoDataType();
 
    /// check if nodata value is deactivated
    bool isEmpty() const; 
 
    void setType(Type t);     ///< set type independent nodata value or deactivate the nodata value
    void setValue(double v);  ///< set a specific nodata value
 
    Type   getType() const;   ///< returns the nodata value type
    double getValue() const;  ///< return a specific nodata value (only relevant if type is Type::value)
 
    /// \brief returns the nodata value for the given raster type.
    /// If the value cannot be converted to the given raster type an exception is thrown. Reasons for exceptions:
    /// 1. type is none (isEmpty() == true) 
    /// 2. raster type cannot represent type (getType() == nan and any integer raster type)
    /// 3. value exceeds raster type limits
    double getValue(RasterDataType rasterType) const;
    /// returns the nodata value for the given raster type but doesn't throw an exception if the value exceeds raster type limits (see above)
    double getValue(RasterDataType rasterType, bool &wasCropped) const;
 
    /// \brief set the nodata value for a given double value considering the raster type (useful when setting from GDAL nodata value).
    void setFromDouble(double v, RasterDataType rasterType);
 
    /// \name CustomOptionType interface
    ///@{
    static const char * help(bool);
    static const char * syntax();
    static bool exportsPythonType();
    ///@}
 
  protected: 
    Type   type_;
    double value_;
  };
}