us_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_US_STORAGE_HPP
#define PACS_SERVICES_SOP_CLASSES_US_STORAGE_HPP
 
#include <array>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::services::sop_classes {
 
// =============================================================================
// Ultrasound Storage SOP Class UIDs
// =============================================================================
 
 
inline constexpr std::string_view us_image_storage_uid =
    "1.2.840.10008.5.1.4.1.1.6.1";
 
inline constexpr std::string_view us_multiframe_image_storage_uid =
    "1.2.840.10008.5.1.4.1.1.6.2";
 
 
 
inline constexpr std::string_view us_image_storage_retired_uid =
    "1.2.840.10008.5.1.4.1.1.6";
 
inline constexpr std::string_view us_multiframe_image_storage_retired_uid =
    "1.2.840.10008.5.1.4.1.1.3.1";
 
 
// =============================================================================
// US-Specific Transfer Syntaxes
// =============================================================================
 
[[nodiscard]] std::vector<std::string> get_us_transfer_syntaxes();
 
// =============================================================================
// US Photometric Interpretations
// =============================================================================
 
enum class us_photometric_interpretation {
    monochrome1,      
    monochrome2,      
    palette_color,    
    rgb,              
    ybr_full,         
    ybr_full_422      
};
 
[[nodiscard]] std::string_view to_string(us_photometric_interpretation interp) noexcept;
 
[[nodiscard]] us_photometric_interpretation
parse_photometric_interpretation(std::string_view value) noexcept;
 
[[nodiscard]] bool is_valid_us_photometric(std::string_view value) noexcept;
 
// =============================================================================
// US SOP Class Information
// =============================================================================
 
struct us_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_us_storage_sop_classes(bool include_retired = true);
 
[[nodiscard]] const us_sop_class_info*
get_us_sop_class_info(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_us_storage_sop_class(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_us_multiframe_sop_class(std::string_view uid) noexcept;
 
// =============================================================================
// US Region Information
// =============================================================================
 
enum class us_region_spatial_format : uint16_t {
    none = 0x0000,           
    two_d = 0x0001,          
    m_mode = 0x0002,         
    spectral = 0x0003,       
    wave_form = 0x0004,      
    graphics = 0x0005        
};
 
enum class us_region_data_type : uint16_t {
    tissue = 0x0001,           
    blood = 0x0002,            
    color_flow = 0x0003,       
    elastography = 0x0004,     
    b_mode = 0x0005            
};
 
}  // namespace kcenon::pacs::services::sop_classes
 
#endif  // PACS_SERVICES_SOP_CLASSES_US_STORAGE_HPP