us_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_US_IOD_VALIDATOR_HPP
#define PACS_SERVICES_VALIDATION_US_IOD_VALIDATOR_HPP
 
#include "kcenon/pacs/core/dicom_dataset.h"
#include "kcenon/pacs/core/dicom_tag.h"
 
#include <optional>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::validation {
 
// =============================================================================
// Validation Result Types
// =============================================================================
 
enum class validation_severity {
    error,      
    warning,    
    info        
};
 
struct validation_finding {
    validation_severity severity;   
    core::dicom_tag tag;            
    std::string message;            
    std::string code;               
};
 
struct validation_result {
    bool is_valid;                          
    std::vector<validation_finding> findings; 
 
    [[nodiscard]] bool has_errors() const noexcept;
 
    [[nodiscard]] bool has_warnings() const noexcept;
 
    [[nodiscard]] size_t error_count() const noexcept;
 
    [[nodiscard]] size_t warning_count() const noexcept;
 
    [[nodiscard]] std::string summary() const;
};
 
// =============================================================================
// Validation Options
// =============================================================================
 
struct us_validation_options {
    bool check_type1 = true;
 
    bool check_type2 = true;
 
    bool check_conditional = true;
 
    bool validate_pixel_data = true;
 
    bool validate_regions = true;
 
    bool allow_retired = true;
 
    bool strict_mode = false;
};
 
// =============================================================================
// US IOD Validator
// =============================================================================
 
class us_iod_validator {
public:
    us_iod_validator() = default;
 
    explicit us_iod_validator(const us_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]] const us_validation_options& options() const noexcept;
 
    void set_options(const us_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_us_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_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;
 
    us_validation_options options_;
};
 
// =============================================================================
// Convenience Functions
// =============================================================================
 
[[nodiscard]] validation_result validate_us_iod(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_valid_us_dataset(const core::dicom_dataset& dataset);
 
}  // namespace kcenon::pacs::services::validation
 
#endif  // PACS_SERVICES_VALIDATION_US_IOD_VALIDATOR_HPP