nm_storage.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_SOP_CLASSES_NM_STORAGE_HPP
#define PACS_SERVICES_SOP_CLASSES_NM_STORAGE_HPP
 
#include <array>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::services::sop_classes {
 
// =============================================================================
// NM Storage SOP Class UIDs
// =============================================================================
 
 
inline constexpr std::string_view nm_image_storage_uid =
    "1.2.840.10008.5.1.4.1.1.20";
 
 
 
inline constexpr std::string_view nm_image_storage_retired_uid =
    "1.2.840.10008.5.1.4.1.1.5";
 
 
// =============================================================================
// NM-Specific Transfer Syntaxes
// =============================================================================
 
[[nodiscard]] std::vector<std::string> get_nm_transfer_syntaxes();
 
// =============================================================================
// NM Photometric Interpretations
// =============================================================================
 
enum class nm_photometric_interpretation {
    monochrome2,        
    palette_color       
};
 
[[nodiscard]] std::string_view to_string(nm_photometric_interpretation interp) noexcept;
 
[[nodiscard]] nm_photometric_interpretation
parse_nm_photometric_interpretation(std::string_view value) noexcept;
 
[[nodiscard]] bool is_valid_nm_photometric(std::string_view value) noexcept;
 
// =============================================================================
// NM SOP Class Information
// =============================================================================
 
struct nm_sop_class_info {
    std::string_view uid;           
    std::string_view name;          
    std::string_view description;   
    bool is_retired;                
    bool supports_multiframe;       
};
 
[[nodiscard]] std::vector<std::string>
get_nm_storage_sop_classes(bool include_retired = true);
 
[[nodiscard]] const nm_sop_class_info*
get_nm_sop_class_info(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_nm_storage_sop_class(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_nm_multiframe_sop_class(std::string_view uid) noexcept;
 
// =============================================================================
// NM Image Type Codes
// =============================================================================
 
enum class nm_type_of_data {
    static_image,       
    dynamic,            
    gated,              
    whole_body,         
    recon_tomo,         
    recon_gated_tomo,   
    tomo,               
    gated_tomo          
};
 
[[nodiscard]] std::string_view to_string(nm_type_of_data type) noexcept;
 
[[nodiscard]] nm_type_of_data parse_nm_type_of_data(std::string_view value) noexcept;
 
// =============================================================================
// NM Detector Information
// =============================================================================
 
enum class nm_detector_geometry {
    planar,             
    ring,               
    partial_ring,       
    curved,             
    cylindrical         
};
 
enum class nm_collimator_type {
    parallel,           
    fan_beam,           
    cone_beam,          
    pinhole,            
    diverging,          
    converging,         
    none                
};
 
[[nodiscard]] std::string_view to_string(nm_collimator_type collimator) noexcept;
 
[[nodiscard]] nm_collimator_type parse_nm_collimator_type(std::string_view value) noexcept;
 
// =============================================================================
// NM Energy Window Information
// =============================================================================
 
struct nm_energy_window_info {
    double lower_limit;     
    double upper_limit;     
    std::string name;       
};
 
enum class nm_radioisotope {
    tc99m,              
    i131,               
    i123,               
    tl201,              
    ga67,               
    in111,              
    f18,                
    other               
};
 
[[nodiscard]] std::string_view to_string(nm_radioisotope isotope) noexcept;
 
[[nodiscard]] double get_primary_energy_kev(nm_radioisotope isotope) noexcept;
 
// =============================================================================
// NM Acquisition Information
// =============================================================================
 
enum class nm_rotation_direction {
    cw,                 
    cc                  
};
 
enum class nm_scan_arc {
    arc_180,            
    arc_360             
};
 
enum class nm_whole_body_technique {
    single_pass,        
    multi_pass,         
    stepping            
};
 
[[nodiscard]] std::string_view to_string(nm_whole_body_technique technique) noexcept;
 
}  // namespace kcenon::pacs::services::sop_classes
 
#endif  // PACS_SERVICES_SOP_CLASSES_NM_STORAGE_HPP