label_map_seg_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_LABEL_MAP_SEG_IOD_VALIDATOR_HPP
#define PACS_SERVICES_VALIDATION_LABEL_MAP_SEG_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 validation_result types
 
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::validation {
 
// =============================================================================
// Label Map Segmentation-Specific DICOM Tags
// =============================================================================
 
namespace label_map_seg_tags {
 
inline constexpr core::dicom_tag segmentation_type{0x0062, 0x0001};
 
inline constexpr core::dicom_tag segment_sequence{0x0062, 0x0002};
 
inline constexpr core::dicom_tag segment_number{0x0062, 0x0004};
 
inline constexpr core::dicom_tag segment_label{0x0062, 0x0005};
 
inline constexpr core::dicom_tag segment_algorithm_type{0x0062, 0x0008};
 
inline constexpr core::dicom_tag segmented_property_category_code_sequence{
    0x0062, 0x0003};
 
inline constexpr core::dicom_tag segmented_property_type_code_sequence{
    0x0062, 0x000F};
 
inline constexpr core::dicom_tag number_of_frames{0x0028, 0x0008};
 
inline constexpr core::dicom_tag shared_functional_groups_sequence{
    0x5200, 0x9229};
 
inline constexpr core::dicom_tag per_frame_functional_groups_sequence{
    0x5200, 0x9230};
 
inline constexpr core::dicom_tag dimension_organization_sequence{
    0x0020, 0x9221};
 
inline constexpr core::dicom_tag dimension_index_sequence{0x0020, 0x9222};
 
inline constexpr core::dicom_tag referenced_series_sequence{0x0008, 0x1115};
 
inline constexpr core::dicom_tag manufacturer{0x0008, 0x0070};
inline constexpr core::dicom_tag manufacturer_model_name{0x0008, 0x1090};
inline constexpr core::dicom_tag device_serial_number{0x0018, 0x1000};
inline constexpr core::dicom_tag software_versions{0x0018, 0x1020};
 
}  // namespace label_map_seg_tags
 
// =============================================================================
// Label Map Segmentation Validation Options
// =============================================================================
 
struct label_map_seg_validation_options {
    bool check_type1 = true;
 
    bool check_type2 = true;
 
    bool check_conditional = true;
 
    bool validate_segment_sequence = true;
 
    bool validate_references = true;
 
    bool validate_pixel_data = true;
 
    bool validate_algorithm_info = true;
 
    bool validate_label_map_instance = true;
 
    bool strict_mode = false;
};
 
// =============================================================================
// Label Map Segmentation IOD Validator
// =============================================================================
 
class label_map_seg_iod_validator {
public:
    label_map_seg_iod_validator() = default;
 
    explicit label_map_seg_iod_validator(
        const label_map_seg_validation_options& options);
 
    [[nodiscard]] validation_result validate(
        const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_segments(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] bool quick_check(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] const label_map_seg_validation_options&
    options() const noexcept;
 
    void set_options(const label_map_seg_validation_options& options);
 
private:
    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_label_map_segmentation_series_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_general_equipment_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_enhanced_general_equipment_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_general_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_label_map_segmentation_image_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_segment_sequence(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_multiframe_functional_groups_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_common_instance_reference_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_segmentation_type(
        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 validate_single_segment(
        const core::dicom_dataset& segment_item,
        size_t segment_index,
        std::vector<validation_finding>& findings) const;
 
    label_map_seg_validation_options options_;
};
 
// =============================================================================
// Convenience Functions
// =============================================================================
 
[[nodiscard]] validation_result validate_label_map_seg_iod(
    const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_valid_label_map_seg_dataset(
    const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_label_map_segmentation(
    const core::dicom_dataset& dataset);
 
}  // namespace kcenon::pacs::services::validation
 
#endif  // PACS_SERVICES_VALIDATION_LABEL_MAP_SEG_IOD_VALIDATOR_HPP