// SPDX-FileCopyrightText: 2025 Filip Leonarski, Paul Scherrer Institute // SPDX-License-Identifier: GPL-3.0-only #include "JFJochHDF5Reader.h" #include "../common/PixelMask.h" #include "../include/spdlog/fmt/fmt.h" std::vector GetDimension(HDF5Object& object, const std::string& path) { const auto dim = object.GetDimension(path); if (dim.size() != 3) throw JFJochException(JFJochExceptionCategory::HDF5, "Wrong dimension of /entry/data/data"); return dim; } template void JFJochHDF5Reader::ReadVector(std::vector &v, HDF5Object &file, const std::string &dataset_name, size_t image0, size_t nimages) { try { auto tmp = file.ReadOptVector(dataset_name); if (tmp.size() == nimages) { v.resize(image0 + nimages); for (int i = 0; i < nimages; i++) v[image0 + i] = tmp[i]; } } catch (JFJochException &e) {} } std::string removeSuffix(const std::string& s, const std::string& suffix) { if (s.rfind(suffix) == s.size() - suffix.size()) { return s.substr(0, s.size() - suffix.size()); } return s; } std::string dataset_name(const std::string& path) { std::string file = path; int pos = file.rfind('/'); if (pos != std::string::npos) file = file.substr(pos+1); file = removeSuffix(file, "_master.h5"); // If previous suffix was not found, try removing this one file = removeSuffix(file, ".h5"); return file; } void JFJochHDF5Reader::ReadFile(const std::string& filename) { std::unique_lock ul(master_file_mutex); try { auto dataset = std::make_shared(); master_file = std::make_unique(filename); dataset->name = dataset_name(filename); dataset->geom.BeamX_pxl(master_file->GetFloat("/entry/instrument/detector/beam_center_x")); dataset->geom.BeamY_pxl(master_file->GetFloat("/entry/instrument/detector/beam_center_y")); float det_distance = master_file->GetFloat("/entry/instrument/detector/distance"); if (det_distance < 0.001) det_distance = 0.1; // Set to 100 mm, if det distance is less than 1 mm dataset->geom.DetectorDistance_mm(det_distance * 1000.0); dataset->geom.PixelSize_mm(master_file->GetFloat("/entry/instrument/detector/x_pixel_size") * 1000.0); dataset->geom.Wavelength_A(master_file->GetFloat("/entry/instrument/beam/incident_wavelength")); dataset->saturation_value = master_file->GetInt("/entry/instrument/detector/saturation_value"); dataset->error_value = master_file->GetOptInt("/entry/instrument/detector/error_value"); dataset->jfjoch_release = master_file->GetString("/entry/instrument/detector/jfjoch_release"); dataset->bit_depth_image = master_file->GetInt("/entry/instrument/detector/bit_depth_image"); dataset->instrument_name = master_file->GetString("/entry/instrument/name"); dataset->source_name = master_file->GetString("/entry/source/name"); dataset->frame_time = master_file->GetFloat("/entry/instrument/detector/frame_time"); dataset->count_time = master_file->GetFloat("/entry/instrument/detector/count_time"); dataset->detector_name = master_file->GetString("/entry/instrument/detector/description"); if (master_file->Exists("/entry/roi")) dataset->roi = master_file->FindLeafs("/entry/roi"); for (const auto &s: dataset->roi) { dataset->roi_max.emplace_back(master_file->ReadVector("/entry/roi/" + s + "/max")); dataset->roi_sum.emplace_back(master_file->ReadVector("/entry/roi/" + s + "/sum")); dataset->roi_sum_sq.emplace_back(master_file->ReadVector("/entry/roi/" + s + "/sum_sq")); dataset->roi_npixel.emplace_back(master_file->ReadVector("/entry/roi/" + s + "/npixel")); } if (master_file->Exists("/entry/instrument/attenuator")) dataset->attenuator_transmission = master_file->GetOptFloat("/entry/instrument/attenuator/attenuator_transmission"); dataset->total_flux = master_file->GetOptFloat("/entry/instrument/beam/total_flux"); if (master_file->Exists("/entry/image/max_value")) dataset->max_value = master_file->ReadVector("/entry/image/max_value"); if (master_file->Exists("/entry/azint") && master_file->Exists("/entry/azint/bin_to_q")) { HDF5DataSet bin_to_q_dataset(*master_file, "/entry/azint/bin_to_q"); bin_to_q_dataset.ReadVector(dataset->az_int_bin_to_q); } if (master_file->Exists("/entry/data/data")) { legacy_format = false; auto dim = GetDimension(*master_file, "/entry/data/data"); number_of_images = dim[0]; dataset->image_size_y = dim[1]; dataset->image_size_x = dim[2]; images_per_file = number_of_images; dataset->efficiency = master_file->ReadVector( "/entry/instrument/detector/detectorSpecific/data_collection_efficiency_image"); dataset->spot_count = master_file->ReadOptVector("/entry/MX/nPeaks"); dataset->indexing_result = master_file->ReadOptVector("/entry/MX/imageIndexed"); dataset->bkg_estimate = master_file->ReadOptVector("/entry/MX/bkgEstimate"); } else if (master_file->Exists("/entry/data/data_000001")) { legacy_format = true; legacy_format_files.clear(); dataset->image_size_x = master_file->GetInt("/entry/instrument/detector/detectorSpecific/x_pixels_in_detector"); dataset->image_size_y = master_file->GetInt("/entry/instrument/detector/detectorSpecific/y_pixels_in_detector"); //size_t expected_images = master_file->GetInt("/entry/instrument/detector/detectorSpecific/nimages"); images_per_file = 0; number_of_images = 0; uint32_t nfiles = 0; std::filesystem::path file_path(filename); std::filesystem::path directory = file_path.parent_path(); while (true) { std::string dname = fmt::format("/entry/data/data_{:06d}", nfiles + 1); if (!master_file->Exists(dname)) break; size_t fimages = 0; try { auto fname = master_file->GetLinkedFileName(dname); if (!directory.empty()) fname = fmt::format("{}/{}", directory.string(),fname); HDF5ReadOnlyFile data_file(fname); fimages = GetDimension(data_file, "/entry/data/data")[0]; legacy_format_files.push_back(fname); ReadVector(dataset->efficiency, data_file, "/entry/detector/data_collection_efficiency_image", number_of_images, fimages); ReadVector(dataset->spot_count, data_file, "/entry/MX/nPeaks", number_of_images, fimages); ReadVector(dataset->indexing_result, data_file, "/entry/MX/imageIndexed", number_of_images, fimages); ReadVector(dataset->bkg_estimate, data_file, "/entry/MX/bkgEstimate", number_of_images, fimages); } catch (JFJochException &e) {} if (nfiles == 0) images_per_file = fimages; number_of_images += fimages; nfiles++; } } else { dataset->image_size_x = master_file->GetInt("/entry/instrument/detector/detectorSpecific/x_pixels_in_detector"); dataset->image_size_y = master_file->GetInt("/entry/instrument/detector/detectorSpecific/y_pixels_in_detector"); number_of_images = 0; } if (dataset->image_size_x * dataset->image_size_y > 0) dataset->pixel_mask = master_file->ReadOptVector( "/entry/instrument/detector/pixel_mask", {0,0}, {dataset->image_size_y, dataset->image_size_x} ); if (dataset->pixel_mask.empty()) dataset->pixel_mask = std::vector(dataset->image_size_x * dataset->image_size_y); dataset->number_of_images = number_of_images; SetStartMessage(dataset); } catch (const std::exception& e) { master_file = {}; number_of_images = 0; SetStartMessage({}); throw; } } void JFJochHDF5Reader::SetStartMessage(std::shared_ptr val) { std::unique_lock ul(start_message_mutex); start_message = val; } std::shared_ptr JFJochHDF5Reader::GetStartMessage() const { std::unique_lock ul(start_message_mutex); if (!start_message) throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "File not loaded"); return start_message; } uint64_t JFJochHDF5Reader::GetNumberOfImages() const { std::unique_lock ul(master_file_mutex); return number_of_images; } void JFJochHDF5Reader::LoadImageDataset(HDF5Object &file, std::vector &output, hsize_t number, hsize_t width, hsize_t height) { output.resize(width * height); std::vector size = {1, height, width}; std::vector start = {static_cast(number), 0, 0}; HDF5DataSet dataset(file, "/entry/data/data"); HDF5DataType datatype(dataset); if (!datatype.IsSigned() && (datatype.GetElemSize() == 4)) { std::vector output_tmp; output_tmp.resize(width * height); dataset.ReadVector(output_tmp, start, size); for (int i = 0; i < output_tmp.size(); i++) { if (output_tmp[i] >= INT32_MAX) output[i] = INT32_MAX; else output[i] = static_cast(output_tmp[i]); } } else dataset.ReadVector(output, start, size); } std::shared_ptr JFJochHDF5Reader::LoadImageInternal(int64_t image_number) { std::unique_lock ul(master_file_mutex); if (!master_file) throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Cannot load image if file not loaded"); auto new_image = std::make_shared(); if (image_number >= number_of_images) throw JFJochException(JFJochExceptionCategory::HDF5, "Image out of bounds"); new_image->number = image_number; std::unique_ptr tmp_data_file; uint32_t image_id; HDF5Object *source_file; if (legacy_format) { uint32_t file_id = image_number / images_per_file; image_id = image_number % images_per_file; tmp_data_file = std::make_unique(legacy_format_files.at(file_id)); source_file = tmp_data_file.get(); } else { image_id = image_number; source_file = master_file.get(); } LoadImageDataset(*source_file, new_image->image, image_id, start_message->image_size_x, start_message->image_size_y); if ((start_message->spot_count.size() > image_number) && (start_message->spot_count[image_number] > 0)) { auto spot_count = start_message->spot_count[image_number]; auto spot_x = source_file->ReadVector( "/entry/MX/peakXPosRaw", {(hsize_t) image_id, 0}, {1, spot_count} ); auto spot_y = source_file->ReadVector( "/entry/MX/peakYPosRaw", {(hsize_t) image_id, 0}, {1, spot_count} ); auto spot_intensity = source_file->ReadVector( "/entry/MX/peakTotalIntensity", {(hsize_t) image_id, 0}, {1, spot_count} ); auto spot_indexed = source_file->ReadVector( "/entry/MX/peakIndexed", {(hsize_t) image_id, 0}, {1, spot_count} ); for (int i = 0; i < spot_count; i++) { new_image->spots.emplace_back(SpotToSave{ .x = spot_x.at(i), .y = spot_y.at(i), .intensity = spot_intensity.at(i), .indexed = (spot_indexed.at(i) != 0) }); } } if (!start_message->az_int_bin_to_q.empty()) { new_image->az_int = source_file->ReadOptVector( "/entry/azint/image", {(hsize_t) image_id, 0}, {1, start_message->az_int_bin_to_q.size()} ); } new_image->dataset = start_message; return new_image; } void JFJochHDF5Reader::Close() { std::unique_lock ul(master_file_mutex); master_file = {}; number_of_images = 0; legacy_format_files.clear(); SetStartMessage({}); }