setup doxygen and clang-uml files

docs/diagrams/aare_class.puml

@@ -0,0 +1,141 @@
+@startuml
+class "NDView<T,ssize_t Ndim=2>" as C_0000853339819629793090
+class C_0000853339819629793090 {
+__
+}
+class "NDView<unsigned short,2L>" as C_0000800815410987673815
+class C_0000800815410987673815 {
+__
+}
+class "NDView<T,Ndim>" as C_0001549403386232143110
+class C_0001549403386232143110 {
+__
+}
+class "NDArray<bool,Ndim>" as C_0000823076622246857026
+class C_0000823076622246857026 {
+__
+}
+class "NDArray<V,Ndim>" as C_0002198222861307321825
+class C_0002198222861307321825 {
+__
+}
+class "NDArray<T,ssize_t Ndim=2>" as C_0001181947618035129503
+class C_0001181947618035129503 {
+__
+}
+class "sls_detector_header" as C_0001674535970515942906
+class C_0001674535970515942906 {
+__
+}
+class "xy" as C_0000162230005032830360
+class C_0000162230005032830360 {
+__
+}
+class "RawFileConfig" as C_0000511537329021463656
+class C_0000511537329021463656 {
+__
+}
+class "Frame" as C_0001608703618093824988
+class C_0001608703618093824988 {
+__
+}
+class "logger::Logger" as C_0001861698262135249810
+class C_0001861698262135249810 {
+__
+}
+class "ZmqHeader" as C_0000690012646166089557
+class C_0000690012646166089557 {
+__
+}
+class "ZmqSocket" as C_0000575290120620432482
+class C_0000575290120620432482 {
+__
+}
+class "ZmqFrame" as C_0001018278375791869829
+class C_0001018278375791869829 {
+__
+}
+class "network_io::NetworkError" as C_0001290043041844945927
+class C_0001290043041844945927 {
+__
+}
+class "ZmqSocketReceiver" as C_0001017868003595712218
+class C_0001017868003595712218 {
+__
+}
+class "ZmqSocketSender" as C_0002178845803227443176
+class C_0002178845803227443176 {
+__
+}
+class "DType" as C_0000703695317535186100
+class C_0000703695317535186100 {
+__
+}
+class "FileConfig" as C_0001694843161451381081
+class C_0001694843161451381081 {
+__
+}
+class "FileInterface" as C_0002122346448923803234
+class C_0002122346448923803234 {
+__
+}
+class "File" as C_0002007196654403438648
+class C_0002007196654403438648 {
+__
+}
+class "NumpyHeader" as C_0002287674849990076068
+class C_0002287674849990076068 {
+__
+}
+class "NumpyFile" as C_0001470720024404954003
+class C_0001470720024404954003 {
+__
+}
+class "SubFile" as C_0001884494008888210849
+class C_0001884494008888210849 {
+__
+}
+class "RawFile" as C_0001505206538021535080
+class C_0001505206538021535080 {
+__
+}
+C_0000800815410987673815 ..|> C_0000853339819629793090
+C_0001549403386232143110 ..|> C_0000853339819629793090
+C_0000823076622246857026 ..|> C_0001181947618035129503
+C_0002198222861307321825 ..|> C_0001181947618035129503
+C_0001181947618035129503 ..> C_0001549403386232143110
+C_0001181947618035129503 ..> C_0000823076622246857026
+C_0001181947618035129503 ..> C_0002198222861307321825
+C_0001018278375791869829 o-- C_0000690012646166089557 : +header
+C_0001018278375791869829 o-- C_0001608703618093824988 : +frame
+C_0001017868003595712218 ..> C_0001018278375791869829
+C_0001017868003595712218 ..> C_0000690012646166089557
+C_0000575290120620432482 <|-- C_0001017868003595712218
+C_0002178845803227443176 ..> C_0000690012646166089557
+C_0002178845803227443176 ..> C_0001018278375791869829
+C_0000575290120620432482 <|-- C_0002178845803227443176
+C_0001694843161451381081 o-- C_0000703695317535186100 : +dtype
+C_0001694843161451381081 o-- C_0000162230005032830360 : +geometry
+C_0002122346448923803234 ..> C_0001608703618093824988
+C_0002007196654403438648 ..> C_0001694843161451381081
+C_0002007196654403438648 ..> C_0001608703618093824988
+C_0002007196654403438648 --> C_0002122346448923803234 : -file_impl
+C_0002287674849990076068 o-- C_0000703695317535186100 : +dtype
+C_0001470720024404954003 ..> C_0001694843161451381081
+C_0001470720024404954003 ..> C_0001608703618093824988
+C_0001470720024404954003 ..> C_0000703695317535186100
+C_0001470720024404954003 o-- C_0002287674849990076068 : -m_header
+C_0002122346448923803234 <|-- C_0001470720024404954003
+C_0001884494008888210849 o-- C_0001884494008888210849 : #read_impl_map
+C_0001505206538021535080 ..> C_0001694843161451381081
+C_0001505206538021535080 ..> C_0001608703618093824988
+C_0001505206538021535080 ..> C_0001674535970515942906
+C_0001505206538021535080 --> C_0001884494008888210849 : -subfiles
+C_0001505206538021535080 o-- C_0000162230005032830360 : -geometry
+C_0001505206538021535080 o-- C_0000162230005032830360 : -positions
+C_0001505206538021535080 o-- C_0000511537329021463656 : -cfg
+C_0002122346448923803234 <|-- C_0001505206538021535080
+
+'Generated with clang-uml, version 0.5.1
+'LLVM version clang version 17.0.6 (Fedora 17.0.6-2.fc39)
+@enduml

docs/diagrams/aare_class_simplified.puml

@@ -0,0 +1,95 @@
+@startuml
+class "sls_detector_header" as C_0001674535970515942906
+class C_0001674535970515942906 {
+__
+}
+class "RawFileConfig" as C_0000511537329021463656
+class C_0000511537329021463656 {
+__
+}
+class "Frame" as C_0001608703618093824988
+class C_0001608703618093824988 {
+__
+}
+class "ZmqHeader" as C_0000690012646166089557
+class C_0000690012646166089557 {
+__
+}
+class "ZmqSocket" as C_0000575290120620432482
+class C_0000575290120620432482 {
+__
+}
+class "ZmqFrame" as C_0001018278375791869829
+class C_0001018278375791869829 {
+__
+}
+class "ZmqSocketReceiver" as C_0001017868003595712218
+class C_0001017868003595712218 {
+__
+}
+class "ZmqSocketSender" as C_0002178845803227443176
+class C_0002178845803227443176 {
+__
+}
+class "DType" as C_0000703695317535186100
+class C_0000703695317535186100 {
+__
+}
+class "FileConfig" as C_0001694843161451381081
+class C_0001694843161451381081 {
+__
+}
+class "FileInterface" as C_0002122346448923803234
+class C_0002122346448923803234 {
+__
+}
+class "File" as C_0002007196654403438648
+class C_0002007196654403438648 {
+__
+}
+class "NumpyHeader" as C_0002287674849990076068
+class C_0002287674849990076068 {
+__
+}
+class "NumpyFile" as C_0001470720024404954003
+class C_0001470720024404954003 {
+__
+}
+class "SubFile" as C_0001884494008888210849
+class C_0001884494008888210849 {
+__
+}
+class "RawFile" as C_0001505206538021535080
+class C_0001505206538021535080 {
+__
+}
+C_0001018278375791869829 o-- C_0000690012646166089557 : +header
+C_0001018278375791869829 o-- C_0001608703618093824988 : +frame
+C_0001017868003595712218 ..> C_0001018278375791869829
+C_0001017868003595712218 ..> C_0000690012646166089557
+C_0000575290120620432482 <|-- C_0001017868003595712218
+C_0002178845803227443176 ..> C_0000690012646166089557
+C_0002178845803227443176 ..> C_0001018278375791869829
+C_0000575290120620432482 <|-- C_0002178845803227443176
+C_0001694843161451381081 o-- C_0000703695317535186100 : +dtype
+C_0002122346448923803234 ..> C_0001608703618093824988
+C_0002007196654403438648 ..> C_0001694843161451381081
+C_0002007196654403438648 ..> C_0001608703618093824988
+C_0002007196654403438648 --> C_0002122346448923803234 : -file_impl
+C_0002287674849990076068 o-- C_0000703695317535186100 : +dtype
+C_0001470720024404954003 ..> C_0001694843161451381081
+C_0001470720024404954003 ..> C_0001608703618093824988
+C_0001470720024404954003 ..> C_0000703695317535186100
+C_0001470720024404954003 o-- C_0002287674849990076068 : -m_header
+C_0002122346448923803234 <|-- C_0001470720024404954003
+C_0001884494008888210849 o-- C_0001884494008888210849 : #read_impl_map
+C_0001505206538021535080 ..> C_0001694843161451381081
+C_0001505206538021535080 ..> C_0001608703618093824988
+C_0001505206538021535080 ..> C_0001674535970515942906
+C_0001505206538021535080 --> C_0001884494008888210849 : -subfiles
+C_0001505206538021535080 o-- C_0000511537329021463656 : -cfg
+C_0002122346448923803234 <|-- C_0001505206538021535080
+
+'Generated with clang-uml, version 0.5.1
+'LLVM version clang version 17.0.6 (Fedora 17.0.6-2.fc39)
+@enduml

docs/diagrams/core_class.puml

@@ -0,0 +1,267 @@
+@startuml
+class "aare::sls_detector_header" as C_0001674535970515942906
+class C_0001674535970515942906 {
+__
++bunchId : uint64_t
++column : uint16_t
++debug : uint32_t
++detType : uint8_t
++expLength : uint32_t
++frameNumber : uint64_t
++modId : uint16_t
++packetMask : uint8_t[64]
++packetNumber : uint32_t
++reserved : uint16_t
++roundRNumber : uint16_t
++row : uint16_t
++timestamp : uint64_t
++version : uint8_t
+}
+class "aare::xy" as C_0000162230005032830360
+class C_0000162230005032830360 {
++operator!=(const xy & other) const : bool
++operator==(const xy & other) const : bool
+__
++col : int
++row : int
+}
+enum "aare::DetectorType" as C_0000214432771357383463
+enum C_0000214432771357383463 {
+Jungfrau
+Eiger
+Mythen3
+Moench
+ChipTestBoard
+}
+enum "aare::TimingMode" as C_0000845115331155903292
+enum C_0000845115331155903292 {
+Auto
+Trigger
+}
+class "aare::RawFileConfig" as C_0000511537329021463656
+class C_0000511537329021463656 {
++operator==(const RawFileConfig & other) const : bool
+__
++module_gap_col : int
++module_gap_row : int
+}
+enum "aare::endian" as C_0000190468130082798308
+enum C_0000190468130082798308 {
+little
+big
+native
+}
+class "aare::DType" as C_0000703695317535186100
+class C_0000703695317535186100 {
++DType(const std::type_info & t) : void
++DType(std::string_view sv) : void
++DType(DType::TypeIndex ti) : void
+..
++operator!=(const DType & other) const noexcept : bool
++operator!=(const std::type_info & t) const : bool
++operator==(const DType & other) const noexcept : bool
++operator==(const std::type_info & t) const : bool
+..
++bitdepth() const : uint8_t
++str() const : std::string
+__
+-m_type : TypeIndex
+}
+enum "aare::DType::TypeIndex" as C_0000575426556754591775
+enum C_0000575426556754591775 {
+INT8
+UINT8
+INT16
+UINT16
+INT32
+UINT32
+INT64
+UINT64
+FLOAT
+DOUBLE
+ERROR
+}
+class "aare::NDView<T,ssize_t Ndim=2>" as C_0000853339819629793090
+class C_0000853339819629793090 {
++NDView() : void
++NDView(T * buffer, std::array<ssize_t,Ndim> shape) : void
++NDView(T * buffer, const std::vector<ssize_t> & shape) : void
++NDView(const NDView<T,Ndim> &) = default : void
++NDView(NDView<T,Ndim> &&) = default : void
+..
++operator=(const NDView<T,Ndim> & other) : NDView<T,Ndim> &
+..
++operator()(ssize_t i) : T &
++operator()<Ix...>(Ix... index) : typename std::enable_if<sizeof...(Ix) == Ndim, T &>::type
++operator()<Ix...>(Ix... index) const : typename std::enable_if<sizeof...(Ix) == Ndim, T &>::type
++operator*=(const T val) : NDView<T,Ndim> &
++operator+=(const T val) : NDView<T,Ndim> &
++operator-=(const T val) : NDView<T,Ndim> &
++operator/=(const T val) : NDView<T,Ndim> &
++operator/=(const NDView<T,Ndim> & other) : NDView<T,Ndim> &
++operator=(const T val) : NDView<T,Ndim> &
++operator==(const NDView<T,Ndim> & other) const : bool
++operator[](ssize_t i) : T &
+..
++begin() : T *
++data() : T *
+-elemenwise<BinaryOperation>(T val, BinaryOperation op) : NDView<T, Ndim> &
+-elemenwise<BinaryOperation>(const NDView<T,Ndim> & other, BinaryOperation op) : NDView<T, Ndim> &
++end() : T *
++shape() : auto &
++shape(ssize_t i) const : auto
++size() const : ssize_t
+__
+-buffer_ : T *
+-shape_ : std::array<ssize_t,Ndim>
+-size_ : ssize_t
+-strides_ : std::array<ssize_t,Ndim>
+}
+class "aare::NDView<unsigned short,2L>" as C_0000800815410987673815
+class C_0000800815410987673815 {
++NDView() : void
++NDView(unsigned short * buffer, std::array<ssize_t,2L> shape) : void
++NDView(unsigned short * buffer, const std::vector<ssize_t> & shape) : void
++NDView(const aare::NDView<uint16_t,2> &) = default : void
++NDView(aare::NDView<uint16_t,2> &&) = default : void
+..
++operator=(const aare::NDView<uint16_t,2> & other) : aare::NDView<uint16_t,2> &
+..
++operator()(ssize_t i) : unsigned short &
++operator()<Ix...>(Ix... index) : typename std::enable_if<sizeof...(Ix) == 2L, unsigned short &>::type
++operator()<Ix...>(Ix... index) const : typename std::enable_if<sizeof...(Ix) == 2L, unsigned short &>::type
++operator*=(const unsigned short val) : aare::NDView<uint16_t,2> &
++operator+=(const unsigned short val) : aare::NDView<uint16_t,2> &
++operator-=(const unsigned short val) : aare::NDView<uint16_t,2> &
++operator/=(const unsigned short val) : aare::NDView<uint16_t,2> &
++operator/=(const aare::NDView<uint16_t,2> & other) : aare::NDView<uint16_t,2> &
++operator=(const unsigned short val) : aare::NDView<uint16_t,2> &
++operator==(const aare::NDView<uint16_t,2> & other) const : bool
++operator[](ssize_t i) : unsigned short &
+..
++begin() : unsigned short *
++data() : unsigned short *
+-elemenwise<BinaryOperation>(unsigned short val, BinaryOperation op) : NDView<uint16_t, 2> &
+-elemenwise<BinaryOperation>(const aare::NDView<uint16_t,2> & other, BinaryOperation op) : NDView<uint16_t, 2> &
++end() : unsigned short *
++shape() : std::array<ssize_t,2L> &
++shape(ssize_t i) const : value_type
++size() const : ssize_t
+__
+-buffer_ : unsigned short *
+-shape_ : std::array<ssize_t,2L>
+-size_ : ssize_t
+-strides_ : std::array<ssize_t,2L>
+}
+class "aare::NDView<T,Ndim>" as C_0001549403386232143110
+class C_0001549403386232143110 {
+__
+}
+class "aare::NDArray<bool,Ndim>" as C_0000823076622246857026
+class C_0000823076622246857026 {
+__
+}
+class "aare::NDArray<V,Ndim>" as C_0002198222861307321825
+class C_0002198222861307321825 {
+__
+}
+class "aare::NDArray<T,ssize_t Ndim=2>" as C_0001181947618035129503
+class C_0001181947618035129503 {
++NDArray() : void
++NDArray(std::array<ssize_t,Ndim> shape) : void
++NDArray(std::array<ssize_t,Ndim> shape, T value) : void
++NDArray(NDView<T,Ndim> span) : void
++NDArray(NDArray<T,Ndim> && other) : void
++NDArray(const NDArray<T,Ndim> & other) : void
++~NDArray() : void
+..
++operator=(NDArray<T,Ndim> && other) : NDArray<T,Ndim> &
++operator=(const NDArray<T,Ndim> & other) : NDArray<T,Ndim> &
+..
++operator!=(const NDArray<T,Ndim> & other) const : bool
++operator&=(const T &) : NDArray<T,Ndim> &
++operator()<Ix...>(Ix... index) const : typename std::enable_if<sizeof...(Ix) == Ndim, T &>::type
++operator()<Ix...>(Ix... index) : typename std::enable_if<sizeof...(Ix) == Ndim, T &>::type
++operator()(int i) const : const T &
++operator()(int i) : T &
++operator*(const NDArray<T,Ndim> & other) : NDArray<T,Ndim>
++operator*(const T &) : NDArray<T,Ndim>
++operator*=(const NDArray<T,Ndim> & other) : NDArray<T,Ndim> &
++operator*=(const T &) : NDArray<T,Ndim> &
++operator+(const NDArray<T,Ndim> & other) : NDArray<T,Ndim>
++operator+(const T &) : NDArray<T,Ndim>
++operator++() : NDArray<T,Ndim> &
++operator+=(const NDArray<T,Ndim> & other) : NDArray<T,Ndim> &
++operator+=(const T &) : NDArray<T,Ndim> &
++operator-(const T &) : NDArray<T,Ndim>
++operator-(const NDArray<T,Ndim> & other) : NDArray<T,Ndim>
++operator-=(const T &) : NDArray<T,Ndim> &
++operator-=(const NDArray<T,Ndim> & other) : NDArray<T,Ndim> &
++operator/(const T &) : NDArray<T,Ndim>
++operator/(const NDArray<T,Ndim> & other) : NDArray<T,Ndim>
++operator/=(const T &) : NDArray<T,Ndim> &
++operator/=<V>(const NDArray<V,Ndim> & other) : NDArray<T, Ndim> &
++operator=(const T &) : NDArray<T,Ndim> &
++operator==(const NDArray<T,Ndim> & other) const : bool
++operator>(const NDArray<T,Ndim> & other) : NDArray<bool,Ndim>
+..
++Print() : void
++Print_all() : void
++Print_some() : void
++begin() : auto
++buffer() : std::byte *
++byte_strides() const noexcept : std::array<ssize_t,Ndim>
++data() : T *
++end() : auto
++reset() : void
++shape(ssize_t i) const noexcept : ssize_t
++shape() const noexcept : std::array<ssize_t,Ndim>
++size() const : ssize_t
++span() const : NDView<T,Ndim>
++sqrt() : void
++strides() const noexcept : std::array<ssize_t,Ndim>
++total_bytes() const : size_t
++value<Ix...>(Ix... index) : typename std::enable_if<sizeof...(Ix) == Ndim, T>::type
+__
+-data_ : T *
+-shape_ : std::array<ssize_t,Ndim>
+-size_ : ssize_t
+-strides_ : std::array<ssize_t,Ndim>
+}
+class "aare::Frame" as C_0001608703618093824988
+class C_0001608703618093824988 {
++Frame(ssize_t rows, ssize_t cols, ssize_t m_bitdepth) : void
++Frame(std::byte * fp, ssize_t rows, ssize_t cols, ssize_t m_bitdepth) : void
++Frame(Frame && other) : void
++Frame(const Frame & other) : void
++~Frame() : void
+..
++operator=(Frame & other) : Frame &
+..
++bitdepth() const : ssize_t
++cols() const : ssize_t
++data() const : std::byte *
++get(int row, int col) : std::byte *
++image<T>() : NDArray<T>
++rows() const : ssize_t
++set<T>(int row, int col, T data) : void
++size() const : ssize_t
++view<T>() : NDView<T>
+__
+-m_bitdepth : ssize_t
+-m_cols : ssize_t
+-m_data : std::byte *
+-m_rows : ssize_t
+}
+C_0000575426556754591775 --+ C_0000703695317535186100
+C_0000800815410987673815 ..|> C_0000853339819629793090
+C_0001549403386232143110 ..|> C_0000853339819629793090
+C_0000823076622246857026 ..|> C_0001181947618035129503
+C_0002198222861307321825 ..|> C_0001181947618035129503
+C_0001181947618035129503 ..> C_0001549403386232143110
+C_0001181947618035129503 ..> C_0000823076622246857026
+C_0001181947618035129503 ..> C_0002198222861307321825
+
+'Generated with clang-uml, version 0.5.1
+'LLVM version clang version 17.0.6 (Fedora 17.0.6-2.fc39)
+@enduml

docs/diagrams/file_io_class.puml

@@ -0,0 +1,200 @@
+@startuml
+enum "aare::DetectorType" as C_0000214432771357383463
+enum C_0000214432771357383463 {
+Jungfrau
+Eiger
+Mythen3
+Moench
+ChipTestBoard
+}
+class "aare::Frame" as C_0001608703618093824988
+class C_0001608703618093824988 {
++Frame(ssize_t rows, ssize_t cols, ssize_t m_bitdepth) : void
++Frame(std::byte * fp, ssize_t rows, ssize_t cols, ssize_t m_bitdepth) : void
++Frame(Frame && other) : void
++Frame(const Frame & other) : void
++~Frame() : void
+..
++operator=(Frame & other) : Frame &
+..
++bitdepth() const : ssize_t
++cols() const : ssize_t
++data() const : std::byte *
++get(int row, int col) : std::byte *
++image<T>() : NDArray<T>
++rows() const : ssize_t
++set<T>(int row, int col, T data) : void
++size() const : ssize_t
++view<T>() : NDView<T>
+__
+-m_bitdepth : ssize_t
+-m_cols : ssize_t
+-m_data : std::byte *
+-m_rows : ssize_t
+}
+class "aare::FileConfig" as C_0001694843161451381081
+class C_0001694843161451381081 {
++operator!=(const FileConfig & other) const : bool
++operator==(const FileConfig & other) const : bool
+__
++cols : uint64_t
++dtype : aare::DType
++geometry : xy
++rows : uint64_t
+}
+abstract "aare::FileInterface" as C_0002122346448923803234
+abstract C_0002122346448923803234 {
++~FileInterface() : void
+..
+{abstract} +bitdepth() const = 0 : ssize_t
+{abstract} +bytes_per_frame() = 0 : size_t
+{abstract} +cols() const = 0 : ssize_t
+{abstract} +frame_number(size_t frame_index) = 0 : size_t
++iread(size_t frame_number) : Frame
++iread(size_t frame_number, size_t n_frames) : std::vector<Frame>
+{abstract} +pixels() = 0 : size_t
+{abstract} +read() = 0 : Frame
+{abstract} +read(size_t n_frames) = 0 : std::vector<Frame>
+{abstract} +read_into(std::byte * image_buf) = 0 : void
+{abstract} +read_into(std::byte * image_buf, size_t n_frames) = 0 : void
+{abstract} +rows() const = 0 : ssize_t
+{abstract} +seek(size_t frame_number) = 0 : void
+{abstract} +tell() = 0 : size_t
+{abstract} +total_frames() const = 0 : size_t
+{abstract} +write(Frame & frame) = 0 : void
+__
++current_frame : size_t
++m_base_name : std::string
++m_base_path : std::filesystem::path
++m_bitdepth : ssize_t
++m_cols : ssize_t
++m_ext : std::string
++m_findex : int
++m_fname : std::filesystem::path
++m_mode : std::string
++m_rows : ssize_t
++m_total_frames : size_t
++m_type : DetectorType
++max_frames_per_file : size_t
++version : std::string
+}
+class "aare::File" as C_0002007196654403438648
+class C_0002007196654403438648 {
++File(std::filesystem::path fname, std::string mode, FileConfig cfg = {}) : void
++File(File && other) : void
++~File() : void
+..
++bitdepth() const : ssize_t
++bytes_per_frame() : size_t
++cols() const : ssize_t
++frame_number(size_t frame_index) : size_t
++iread(size_t frame_number) : Frame
++pixels() : size_t
++read() : Frame
++read(size_t n_frames) : std::vector<Frame>
++read_into(std::byte * image_buf) : void
++read_into(std::byte * image_buf, size_t n_frames) : void
++rows() const : ssize_t
++seek(size_t frame_number) : void
++tell() const : size_t
++total_frames() const : size_t
++write(Frame & frame) : void
+__
+-file_impl : FileInterface *
+}
+class "aare::NumpyFile" as C_0001470720024404954003
+class C_0001470720024404954003 {
++NumpyFile(const std::filesystem::path & fname, const std::string & mode = "r", FileConfig cfg = {}) : void
++~NumpyFile() : void
+..
++bitdepth() const : ssize_t
++bytes_per_frame() : size_t
++cols() const : ssize_t
++dtype() const : DType
++frame_number(size_t frame_index) : size_t
+-get_frame(size_t frame_number) : Frame
+-get_frame_into(size_t, std::byte *) : void
++load<T,size_t NDim>() : NDArray<T, NDim>
+-load_metadata() : void
++pixels() : size_t
++read() : Frame
++read(size_t n_frames) : std::vector<Frame>
++read_into(std::byte * image_buf, size_t n_frames) : void
++read_into(std::byte * image_buf) : void
++rows() const : ssize_t
++seek(size_t frame_number) : void
++shape() const : std::vector<size_t>
++tell() : size_t
++total_frames() const : size_t
++write(Frame & frame) : void
+__
+-current_frame : size_t
+-fp : FILE *
+-header_len : uint32_t
+-header_len_size : uint8_t
+-header_size : size_t
+-initial_header_len : size_t
+-m_header : NumpyHeader
+-major_ver_ : uint8_t
+-minor_ver_ : uint8_t
+}
+class "aare::RawFile" as C_0001505206538021535080
+class C_0001505206538021535080 {
++RawFile(const std::filesystem::path & fname, const std::string & mode = "r", const FileConfig & cfg = {}) : void
++~RawFile() : void
+..
++bitdepth() const : ssize_t
++bytes_per_frame() : size_t
++cols() const : ssize_t
++data_fname(int mod_id, int file_id) : std::filesystem::path
+-find_geometry() : void
++find_number_of_subfiles() : void
++frame_number(size_t frame_index) : size_t
+-get_frame(size_t frame_number) : Frame
+-get_frame_into(size_t frame_number, std::byte * image_buf) : void
+{static} +is_master_file(std::filesystem::path fpath) : bool
++master_fname() : std::filesystem::path
+-open_subfiles() : void
+-parse_fname() : void
+-parse_json_metadata() : void
+-parse_metadata() : void
+-parse_raw_metadata() : void
++pixels() : size_t
++read(size_t n_frames) : std::vector<Frame>
++read() : Frame
+-read_header(const std::filesystem::path & fname) : sls_detector_header
++read_into(std::byte * image_buf, size_t n_frames) : void
++read_into(std::byte * image_buf) : void
++rows() const : ssize_t
++seek(size_t frame_number) : void
++set_config(int row, int col) : void
++tell() : size_t
++total_frames() const : size_t
++write(Frame & frame) : void
+__
+-cfg : RawFileConfig
+-geometry : xy
+-n_subfile_parts : size_t
+-n_subfiles : size_t
+-positions : std::vector<xy>
+-quad : bool
+-subfile_cols : int
+-subfile_rows : int
+-subfiles : std::vector<std::vector<SubFile *>>
+-timing_mode : TimingMode
+}
+C_0002122346448923803234 ..> C_0001608703618093824988
+C_0002122346448923803234 o-- C_0000214432771357383463 : +m_type
+C_0002007196654403438648 ..> C_0001694843161451381081
+C_0002007196654403438648 ..> C_0001608703618093824988
+C_0002007196654403438648 --> C_0002122346448923803234 : -file_impl
+C_0001470720024404954003 ..> C_0001694843161451381081
+C_0001470720024404954003 ..> C_0001608703618093824988
+C_0002122346448923803234 <|-- C_0001470720024404954003
+C_0001505206538021535080 ..> C_0001694843161451381081
+C_0001505206538021535080 ..> C_0001608703618093824988
+C_0002122346448923803234 <|-- C_0001505206538021535080
+
+'Generated with clang-uml, version 0.5.1
+'LLVM version clang version 17.0.6 (Fedora 17.0.6-2.fc39)
+@enduml

docs/diagrams/network_io_class.puml

@@ -0,0 +1,136 @@
+@startuml
+class "aare::Frame" as C_0001608703618093824988
+class C_0001608703618093824988 {
++Frame(ssize_t rows, ssize_t cols, ssize_t m_bitdepth) : void
++Frame(std::byte * fp, ssize_t rows, ssize_t cols, ssize_t m_bitdepth) : void
++Frame(Frame && other) : void
++Frame(const Frame & other) : void
++~Frame() : void
+..
++operator=(Frame & other) : Frame &
+..
++bitdepth() const : ssize_t
++cols() const : ssize_t
++data() const : std::byte *
++get(int row, int col) : std::byte *
++image<T>() : NDArray<T>
++rows() const : ssize_t
++set<T>(int row, int col, T data) : void
++size() const : ssize_t
++view<T>() : NDView<T>
+__
+-m_bitdepth : ssize_t
+-m_cols : ssize_t
+-m_data : std::byte *
+-m_rows : ssize_t
+}
+class "aare::ZmqHeader" as C_0000690012646166089557
+class C_0000690012646166089557 {
++operator==(const ZmqHeader & other) const : bool
+..
++from_string(std::string & s) : void
++to_string() const : std::string
+__
++acqIndex : uint64_t
++addJsonHeader : std::map<std::string,std::string>
++column : uint16_t
++completeImage : bool
++data : bool
++detSpec1 : uint64_t
++detSpec2 : uint16_t
++detSpec3 : uint32_t
++detSpec4 : uint16_t
++detType : uint8_t
++dynamicRange : uint32_t
++expLength : uint32_t
++fileIndex : uint64_t
++flipRows : int
++fname : std::string
++frameIndex : uint64_t
++frameNumber : uint64_t
++imageSize : uint32_t
++jsonversion : uint32_t
++modId : uint16_t
++ndetx : uint32_t
++ndety : uint32_t
++npixelsx : uint32_t
++npixelsy : uint32_t
++packetNumber : uint32_t
++progress : double
++quad : uint32_t
++row : uint16_t
++rx_roi : std::array<int,4>
++timestamp : uint64_t
++version : uint8_t
+}
+class "aare::ZmqSocket" as C_0000575290120620432482
+class C_0000575290120620432482 {
++ZmqSocket() = default : void
++ZmqSocket(const ZmqSocket &) = deleted : void
++ZmqSocket(ZmqSocket &&) = deleted : void
++~ZmqSocket() : void
+..
++operator=(const ZmqSocket &) = deleted : ZmqSocket
+..
++disconnect() : void
++set_potential_frame_size(size_t size) : void
++set_timeout_ms(int n) : void
++set_zmq_hwm(int hwm) : void
+__
+#m_context : void *
+#m_endpoint : std::string
+#m_header_buffer : char *
+{static} #m_max_header_size : const size_t
+#m_potential_frame_size : size_t
+#m_socket : void *
+#m_timeout_ms : int
+#m_zmq_hwm : int
+}
+class "aare::ZmqFrame" as C_0001018278375791869829
+class C_0001018278375791869829 {
+__
++frame : Frame
++header : ZmqHeader
+}
+class "aare::network_io::NetworkError" as C_0001290043041844945927
+class C_0001290043041844945927 {
++NetworkError(const char * msg) : void
++NetworkError(const std::string msg) : void
+..
++what() const noexcept : const char *
+__
+-m_msg : const char *
+}
+class "aare::ZmqSocketReceiver" as C_0001017868003595712218
+class C_0001017868003595712218 {
++ZmqSocketReceiver(const std::string & endpoint) : void
+..
++connect() : void
+-receive_data(std::byte * data, size_t size) : int
+-receive_header() : ZmqHeader
++receive_n() : std::vector<ZmqFrame>
+-receive_zmqframe() : ZmqFrame
+__
+}
+class "aare::ZmqSocketSender" as C_0002178845803227443176
+class C_0002178845803227443176 {
++ZmqSocketSender(const std::string & endpoint) : void
+..
++bind() : void
++send(const ZmqHeader & header, const std::byte * data, size_t size) : size_t
++send(const ZmqFrame & zmq_frame) : size_t
++send(const std::vector<ZmqFrame> & zmq_frames) : size_t
+__
+}
+C_0001018278375791869829 o-- C_0000690012646166089557 : +header
+C_0001018278375791869829 o-- C_0001608703618093824988 : +frame
+C_0001017868003595712218 ..> C_0001018278375791869829
+C_0001017868003595712218 ..> C_0000690012646166089557
+C_0000575290120620432482 <|-- C_0001017868003595712218
+C_0002178845803227443176 ..> C_0000690012646166089557
+C_0002178845803227443176 ..> C_0001018278375791869829
+C_0000575290120620432482 <|-- C_0002178845803227443176
+
+'Generated with clang-uml, version 0.5.1
+'LLVM version clang version 17.0.6 (Fedora 17.0.6-2.fc39)
+@enduml