xa_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_XA_IOD_VALIDATOR_HPP
#define PACS_SERVICES_VALIDATION_XA_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 <optional>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::validation {
 
// =============================================================================
// XA-Specific DICOM Tags (not in core tag constants)
// =============================================================================
 
namespace xa_tags {
 
inline constexpr core::dicom_tag number_of_frames{0x0028, 0x0008};
 
inline constexpr core::dicom_tag frame_time{0x0018, 0x1063};
 
inline constexpr core::dicom_tag frame_time_vector{0x0018, 0x1065};
 
inline constexpr core::dicom_tag cine_rate{0x0018, 0x0040};
 
inline constexpr core::dicom_tag recommended_display_frame_rate{0x0008, 0x2144};
 
inline constexpr core::dicom_tag field_of_view_shape{0x0018, 0x1147};
 
inline constexpr core::dicom_tag field_of_view_dimensions{0x0018, 0x1149};
 
inline constexpr core::dicom_tag positioner_motion{0x0018, 0x1500};
 
inline constexpr core::dicom_tag positioner_primary_angle{0x0018, 0x1510};
 
inline constexpr core::dicom_tag positioner_secondary_angle{0x0018, 0x1511};
 
inline constexpr core::dicom_tag positioner_primary_angle_increment{0x0018, 0x1520};
 
inline constexpr core::dicom_tag positioner_secondary_angle_increment{0x0018, 0x1521};
 
inline constexpr core::dicom_tag imager_pixel_spacing{0x0018, 0x1164};
 
inline constexpr core::dicom_tag distance_source_to_detector{0x0018, 0x1110};
 
inline constexpr core::dicom_tag distance_source_to_patient{0x0018, 0x1111};
 
inline constexpr core::dicom_tag intensifier_size{0x0018, 0x1162};
 
inline constexpr core::dicom_tag grid{0x0018, 0x1166};
 
inline constexpr core::dicom_tag kvp{0x0018, 0x0060};
 
inline constexpr core::dicom_tag exposure_time{0x0018, 0x1150};
 
inline constexpr core::dicom_tag xray_tube_current{0x0018, 0x1151};
 
}  // namespace xa_tags
 
// =============================================================================
// XA Validation Options
// =============================================================================
 
struct xa_validation_options {
    bool check_type1 = true;
 
    bool check_type2 = true;
 
    bool check_conditional = true;
 
    bool validate_pixel_data = true;
 
    bool validate_positioner = true;
 
    bool validate_calibration = true;
 
    bool validate_multiframe_timing = true;
 
    bool strict_mode = false;
};
 
// =============================================================================
// XA IOD Validator
// =============================================================================
 
class xa_iod_validator {
public:
    xa_iod_validator() = default;
 
    explicit xa_iod_validator(const xa_validation_options& options);
 
    [[nodiscard]] validation_result validate(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_multiframe(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] bool quick_check(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_calibration(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] const xa_validation_options& options() const noexcept;
 
    void set_options(const xa_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_xa_acquisition_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_xa_image_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_multiframe_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_calibration_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_xa_photometric(
        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;
 
    void check_positioner_angles(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    xa_validation_options options_;
};
 
// =============================================================================
// Convenience Functions
// =============================================================================
 
[[nodiscard]] validation_result validate_xa_iod(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_valid_xa_dataset(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool has_qca_calibration(const core::dicom_dataset& dataset);
 
}  // namespace kcenon::pacs::services::validation
 
#endif  // PACS_SERVICES_VALIDATION_XA_IOD_VALIDATOR_HPP