scaleoffset.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5cpp.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the
// Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
// Boston, MA  02110-1301 USA
// ===========================================================================
//
// Authors:
//         Eugen Wintersberger <eugen.wintersberger@desy.de>
//         Jan Kotanski <jan.kotanski@desy.de>
// Created on: Dec 20, 2020
//
#pragma once

#include <iostream>
#include <h5cpp/filter/filter.hpp>

namespace hdf5 {
namespace filter {


enum class SOScaleType: std::underlying_type<H5Z_SO_scale_type_t>::type {
  FLOAT_DSCALE = H5Z_SO_FLOAT_DSCALE,  // Floating-point type, using variable MinBits method
  FLOAT_ESCALE = H5Z_SO_FLOAT_ESCALE,  // Floating-point type, using fixed MinBits method
  INT = H5Z_SO_INT                     // Integer type
};


class DLL_EXPORT ScaleOffset : public Filter
{
  private:
    SOScaleType scale_type_;
    int scale_factor_;
  public:
    ScaleOffset();
    ScaleOffset(SOScaleType scale_type, int scale_factor);
    ~ScaleOffset();

    SOScaleType scale_type() const noexcept;

    void scale_type(SOScaleType scale_type);

    int scale_factor() const noexcept;

    void scale_factor(int scale_factor);

    virtual void operator()(const property::DatasetCreationList &dcpl,
                            Availability flag=Availability::MANDATORY) const;

};



DLL_EXPORT std::ostream &operator<<(std::ostream &stream, const SOScaleType &scale_type);


} // namespace filter
} // namespace hdf5