dicom_file.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.
 
#pragma once
 
#include "dicom_dataset.h"
#include "dicom_tag_constants.h"
#include "result.h"
 
#include <kcenon/pacs/encoding/transfer_syntax.h>
 
#include <cstdint>
#include <filesystem>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::core {
 
class dicom_file {
public:
 
    // ========================================================================
    // Static Factory Methods (Reading)
    // ========================================================================
 
    [[nodiscard]] static auto open(const std::filesystem::path& path)
        -> kcenon::pacs::Result<dicom_file>;
 
    [[nodiscard]] static auto from_bytes(std::span<const uint8_t> data)
        -> kcenon::pacs::Result<dicom_file>;
 
    // ========================================================================
    // Static Factory Methods (Creation)
    // ========================================================================
 
    [[nodiscard]] static auto create(dicom_dataset dataset,
                                     const encoding::transfer_syntax& ts)
        -> dicom_file;
 
    // ========================================================================
    // Writing
    // ========================================================================
 
    [[nodiscard]] auto save(const std::filesystem::path& path) const
        -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto to_bytes() const -> std::vector<uint8_t>;
 
    // ========================================================================
    // Accessors
    // ========================================================================
 
    [[nodiscard]] auto meta_information() const noexcept -> const dicom_dataset&;
 
    [[nodiscard]] auto meta_information() noexcept -> dicom_dataset&;
 
    [[nodiscard]] auto dataset() const noexcept -> const dicom_dataset&;
 
    [[nodiscard]] auto dataset() noexcept -> dicom_dataset&;
 
    // ========================================================================
    // Convenience Accessors
    // ========================================================================
 
    [[nodiscard]] auto transfer_syntax() const -> encoding::transfer_syntax;
 
    [[nodiscard]] auto sop_class_uid() const -> std::string;
 
    [[nodiscard]] auto sop_instance_uid() const -> std::string;
 
    // ========================================================================
    // Construction
    // ========================================================================
 
    dicom_file() = default;
 
    dicom_file(const dicom_file&) = default;
 
    dicom_file(dicom_file&&) noexcept = default;
 
    auto operator=(const dicom_file&) -> dicom_file& = default;
 
    auto operator=(dicom_file&&) noexcept -> dicom_file& = default;
 
    ~dicom_file() = default;
 
private:
    dicom_file(dicom_dataset meta_info, dicom_dataset main_dataset);
 
    [[nodiscard]] static auto parse_meta_information(
        std::span<const uint8_t> data, size_t& bytes_read)
        -> kcenon::pacs::Result<dicom_dataset>;
 
    [[nodiscard]] static auto generate_meta_information(
        const dicom_dataset& dataset, const encoding::transfer_syntax& ts)
        -> dicom_dataset;
 
    [[nodiscard]] static auto encode_explicit_vr_le(const dicom_dataset& dataset)
        -> std::vector<uint8_t>;
 
    [[nodiscard]] static auto decode_explicit_vr_le(
        std::span<const uint8_t> data, size_t& bytes_read)
        -> kcenon::pacs::Result<dicom_dataset>;
 
    [[nodiscard]] static auto decode_implicit_vr_le(
        std::span<const uint8_t> data, size_t& bytes_read)
        -> kcenon::pacs::Result<dicom_dataset>;
 
    [[nodiscard]] static auto decode_explicit_vr_be(
        std::span<const uint8_t> data, size_t& bytes_read)
        -> kcenon::pacs::Result<dicom_dataset>;
 
    [[nodiscard]] static auto encode_implicit_vr_le(const dicom_dataset& dataset)
        -> std::vector<uint8_t>;
 
    [[nodiscard]] static auto encode_explicit_vr_be(const dicom_dataset& dataset)
        -> std::vector<uint8_t>;
 
    [[nodiscard]] static auto decode_dataset(
        std::span<const uint8_t> data,
        const encoding::transfer_syntax& ts,
        size_t& bytes_read)
        -> kcenon::pacs::Result<dicom_dataset>;
 
    [[nodiscard]] static auto encode_dataset(
        const dicom_dataset& dataset,
        const encoding::transfer_syntax& ts)
        -> std::vector<uint8_t>;
 
    [[nodiscard]] static auto parse_undefined_length_sequence(
        std::span<const uint8_t> data, size_t& bytes_read,
        bool explicit_vr, bool big_endian)
        -> kcenon::pacs::Result<std::vector<dicom_dataset>>;
 
    [[nodiscard]] static auto parse_encapsulated_frames(
        std::span<const uint8_t> data)
        -> std::vector<std::vector<uint8_t>>;
 
    dicom_dataset meta_info_;
 
    dicom_dataset dataset_;
 
    static constexpr std::string_view kImplementationClassUid =
        "1.2.826.0.1.3680043.8.1055.1";
 
    static constexpr std::string_view kImplementationVersionName = "PACS_SYS_001";
 
    static constexpr uint8_t kDicmPrefix[4] = {'D', 'I', 'C', 'M'};
 
    static constexpr size_t kPreambleSize = 128;
};
 
}  // namespace kcenon::pacs::core