HDF5ArrayDataSetConfig.hpp

Go to the documentation of this file.

#pragma once
 
#include <vector>
 
#include <H5Ppublic.h>
 
#include "io/BaseIO.hpp"

namespace AQNWB::IO::HDF5
{

class HDF5FilterConfig
{
public:
  HDF5FilterConfig(H5Z_filter_t filter_id,
                   const std::vector<unsigned int>& cd_values);
 
  // The ID of the filter
  H5Z_filter_t filter_id;
  // The client data array
  std::vector<unsigned int> cd_values;

  static HDF5FilterConfig createGzipFilter(unsigned int level = 4);

  static HDF5FilterConfig createShuffleFilter();

  static HDF5FilterConfig createFletcher32Filter();

  static HDF5FilterConfig createNbitFilter();
};

class HDF5ArrayDataSetConfig : public ArrayDataSetConfig
{
public:
  HDF5ArrayDataSetConfig(const BaseDataType& type,
                         const SizeArray& shape,
                         const SizeArray& chunking);

  void addFilter(H5Z_filter_t filter_id,
                 const std::vector<unsigned int>& cd_values);

  void addFilter(const HDF5FilterConfig& filter);

  void addFilters(const std::vector<HDF5FilterConfig>& filters);

  const std::vector<HDF5FilterConfig>& getFilters() const;
 
private:
  // The filters of the dataset
  std::vector<HDF5FilterConfig> m_filters;
};
 
}  // namespace AQNWB::IO::HDF5