Taking v1 as the first release (#92)

- file reading
- decoding master file

include/aare/RawFile.hpp

@@ -0,0 +1,110 @@
+#pragma once
+#include "aare/FileInterface.hpp"
+#include "aare/RawMasterFile.hpp"
+#include "aare/Frame.hpp"
+#include "aare/NDArray.hpp" //for pixel map
+#include "aare/SubFile.hpp"
+
+#include <optional>
+
+namespace aare {
+
+struct ModuleConfig {
+    int module_gap_row{};
+    int module_gap_col{};
+
+    bool operator==(const ModuleConfig &other) const {
+        if (module_gap_col != other.module_gap_col)
+            return false;
+        if (module_gap_row != other.module_gap_row)
+            return false;
+        return true;
+    }
+};
+
+/**
+ * @brief Class to read .raw files. The class will parse the master file
+ * to find the correct geometry for the frames.
+ * @note A more generic interface is available in the aare::File class.
+ * Consider using that unless you need raw file specific functionality.
+ */
+class RawFile : public FileInterface {
+    size_t n_subfiles{};
+    size_t n_subfile_parts{};
+    std::vector<std::vector<SubFile *>> subfiles;
+    std::vector<xy> positions;
+    ModuleConfig cfg{0, 0};
+
+    RawMasterFile m_master;
+
+    size_t m_current_frame{};
+    size_t m_rows{};
+    size_t m_cols{};
+
+  public:
+    /**
+     * @brief RawFile constructor
+     * @param fname path to the master file (.json)
+     * @param mode file mode (only "r" is supported at the moment)
+
+     */
+    RawFile(const std::filesystem::path &fname, const std::string &mode = "r");
+    virtual ~RawFile() override;
+
+    Frame read_frame() override;
+    Frame read_frame(size_t frame_number) override;
+    std::vector<Frame> read_n(size_t n_frames) override;
+    void read_into(std::byte *image_buf) override;
+    void read_into(std::byte *image_buf, size_t n_frames) override;
+    size_t frame_number(size_t frame_index) override;
+    size_t bytes_per_frame() override;
+    size_t pixels_per_frame() override;
+    void seek(size_t frame_index) override;
+    size_t tell() override;
+    size_t total_frames() const override;
+    size_t rows() const override;
+    size_t cols() const override;
+    size_t bitdepth() const override;
+    xy geometry();
+
+    DetectorType detector_type() const override;
+
+  private:
+  /**
+     * @brief check if the file is a master file
+     * @param fpath path to the file
+     */
+    static bool is_master_file(const std::filesystem::path &fpath);
+
+        // TODO! Deal with fast quad and missing files
+
+    /**
+     * @brief read the frame at the given frame index into the image buffer
+     * @param frame_number frame number to read
+     * @param image_buf buffer to store the frame
+     */
+    void get_frame_into(size_t frame_index, std::byte *frame_buffer);
+
+    /**
+     * @brief get the frame at the given frame index
+     * @param frame_number frame number to read
+     * @return Frame
+     */
+    Frame get_frame(size_t frame_index);
+
+
+
+    /**
+     * @brief read the header of the file
+     * @param fname path to the data subfile
+     * @return DetectorHeader
+     */
+    static DetectorHeader read_header(const std::filesystem::path &fname);
+
+
+    void find_number_of_subfiles();
+    void open_subfiles();
+    void find_geometry();
+};
+
+} // namespace aare