nm_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_NM_IOD_VALIDATOR_HPP
#define PACS_SERVICES_VALIDATION_NM_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"  // For shared validation types
 
#include <optional>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::validation {
 
// =============================================================================
// NM Validation Options
// =============================================================================
 
struct nm_validation_options {
    bool check_type1 = true;
 
    bool check_type2 = true;
 
    bool check_conditional = true;
 
    bool validate_pixel_data = true;
 
    bool validate_nm_specific = true;
 
    bool validate_energy_windows = true;
 
    bool validate_isotope = true;
 
    bool allow_retired = true;
 
    bool strict_mode = false;
};
 
// =============================================================================
// NM IOD Validator
// =============================================================================
 
class nm_iod_validator {
public:
    nm_iod_validator() = default;
 
    explicit nm_iod_validator(const nm_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 nm_validation_options& options() const noexcept;
 
    void set_options(const nm_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_nm_series_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_nm_image_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_nm_isotope_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_nm_detector_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_nm_tomo_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_nm_gated_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;
 
    // NM-specific validation
    void validate_energy_window_info(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_radiopharmaceutical_info(
        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;
 
    nm_validation_options options_;
};
 
// =============================================================================
// Convenience Functions
// =============================================================================
 
[[nodiscard]] validation_result validate_nm_iod(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_valid_nm_dataset(const core::dicom_dataset& dataset);
 
}  // namespace kcenon::pacs::services::validation
 
#endif  // PACS_SERVICES_VALIDATION_NM_IOD_VALIDATOR_HPP