image_info.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_DATA_IMAGE_INFO_HPP
#define MLPACK_CORE_DATA_IMAGE_INFO_HPP


#include <mlpack/prereqs.hpp>

#include "extension.hpp"

#ifdef HAS_STB // Compile this only if stb is present.

#define STB_IMAGE_STATIC
#define STB_IMAGE_IMPLEMENTATION
#include <stb_image.h>

#define STB_IMAGE_WRITE_STATIC
#define STB_IMAGE_WRITE_IMPLEMENTATION
#include <stb_image_write.h>

#endif

namespace mlpack {
namespace data {

#ifdef HAS_STB // Compile this only if stb is present.

inline bool ImageFormatSupported(const std::string& fileName,
                                 const bool save = false);

#endif

class ImageInfo
{
 public:
  ImageInfo(const size_t width = 0,
            const size_t height = 0,
            const size_t channels = 3,
            const size_t quality = 90);

  const size_t& Width() const { return width; }
  size_t& Width() { return width; }

  const size_t& Height() const { return height; }
  size_t& Height() { return height; }

  const size_t& Channels() const { return channels; }
  size_t& Channels() { return channels; }

  const size_t& Quality() const { return quality; }
  size_t& Quality() { return quality; }

 private:
  // To store the image width.
  size_t width;

  // To store the image height.
  size_t height;

  // To store the number of channels in the image.
  size_t channels;

  // Compression of the image if saved as jpg (0 - 100).
  size_t quality;
};

} // namespace data
} // namespace mlpack

// Include implementation of Image.
#include "image_info_impl.hpp"

#endif