wsi_iod_validator.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#ifndef PACS_SERVICES_VALIDATION_WSI_IOD_VALIDATOR_HPP
#define PACS_SERVICES_VALIDATION_WSI_IOD_VALIDATOR_HPP
 
#include "kcenon/pacs/core/dicom_dataset.h"
#include "kcenon/pacs/core/dicom_tag.h"
#include "kcenon/pacs/services/validation/us_iod_validator.h"  // Reuse validation types
 
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::validation {
 
// =============================================================================
// WSI-Specific DICOM Tags for Validation
// =============================================================================
 
namespace wsi_iod_tags {
 
inline constexpr core::dicom_tag total_pixel_matrix_columns{0x0048, 0x0006};
 
inline constexpr core::dicom_tag total_pixel_matrix_rows{0x0048, 0x0007};
 
inline constexpr core::dicom_tag total_pixel_matrix_focal_planes{0x0048, 0x0008};
 
inline constexpr core::dicom_tag image_orientation_slide{0x0048, 0x0102};
 
inline constexpr core::dicom_tag dimension_organization_type{0x0020, 0x9311};
 
inline constexpr core::dicom_tag number_of_frames{0x0028, 0x0008};
 
inline constexpr core::dicom_tag imaged_volume_width{0x0048, 0x0001};
 
inline constexpr core::dicom_tag imaged_volume_height{0x0048, 0x0002};
 
inline constexpr core::dicom_tag optical_path_identifier{0x0048, 0x0105};
 
inline constexpr core::dicom_tag optical_path_description{0x0048, 0x0106};
 
inline constexpr core::dicom_tag specimen_identifier{0x0040, 0x0551};
 
inline constexpr core::dicom_tag container_identifier{0x0040, 0x0512};
 
}  // namespace wsi_iod_tags
 
// =============================================================================
// WSI Validation Options
// =============================================================================
 
struct wsi_validation_options {
    bool check_type1 = true;
 
    bool check_type2 = true;
 
    bool check_conditional = true;
 
    bool validate_pixel_data = true;
 
    bool validate_wsi_params = true;
 
    bool validate_optical_path = true;
 
    bool strict_mode = false;
};
 
// =============================================================================
// WSI IOD Validator
// =============================================================================
 
class wsi_iod_validator {
public:
    wsi_iod_validator() = default;
 
    explicit wsi_iod_validator(const wsi_validation_options& options);
 
    [[nodiscard]] validation_result validate(
        const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] bool quick_check(
        const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] const wsi_validation_options& options() const noexcept;
 
    void set_options(const wsi_validation_options& options);
 
private:
    // Module validation methods
    void validate_patient_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_general_study_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_general_series_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_wsi_image_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_optical_path_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_multiframe_dimension_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_image_pixel_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_specimen_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_sop_common_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    // Attribute validation helpers
    void check_type1_attribute(
        const core::dicom_dataset& dataset,
        core::dicom_tag tag,
        std::string_view name,
        std::vector<validation_finding>& findings) const;
 
    void check_type2_attribute(
        const core::dicom_dataset& dataset,
        core::dicom_tag tag,
        std::string_view name,
        std::vector<validation_finding>& findings) const;
 
    void check_modality(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void check_pixel_data_consistency(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    wsi_validation_options options_;
};
 
// =============================================================================
// Convenience Functions
// =============================================================================
 
[[nodiscard]] validation_result validate_wsi_iod(
    const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_valid_wsi_dataset(const core::dicom_dataset& dataset);
 
}  // namespace kcenon::pacs::services::validation
 
#endif  // PACS_SERVICES_VALIDATION_WSI_IOD_VALIDATOR_HPP