wsi-dicom-annotations 0.2.1

DICOM WSI ANN, SEG, SR, and Parametric Map interoperability
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use crate::Result;

use super::{validate_generation, AlgorithmIdentification, DicomCode, GenerationType};

#[derive(Debug, Clone, PartialEq)]
pub(crate) struct FindingSemantics {
    generation_type: GenerationType,
    algorithms: Vec<AlgorithmIdentification>,
    category: DicomCode,
    property_type: DicomCode,
    property_type_modifiers: Vec<DicomCode>,
    anatomic_regions: Vec<DicomCode>,
    primary_anatomic_structures: Vec<DicomCode>,
    recommended_display_cielab: [u16; 3],
}

impl FindingSemantics {
    #[allow(clippy::too_many_arguments)]
    pub(crate) fn new(
        generation_type: GenerationType,
        algorithms: Vec<AlgorithmIdentification>,
        category: DicomCode,
        property_type: DicomCode,
        property_type_modifiers: Vec<DicomCode>,
        anatomic_regions: Vec<DicomCode>,
        primary_anatomic_structures: Vec<DicomCode>,
        recommended_display_cielab: [u16; 3],
    ) -> Result<Self> {
        validate_generation(generation_type, &algorithms)?;
        Ok(Self {
            generation_type,
            algorithms,
            category,
            property_type,
            property_type_modifiers,
            anatomic_regions,
            primary_anatomic_structures,
            recommended_display_cielab,
        })
    }

    pub(crate) fn manual(
        category: DicomCode,
        property_type: DicomCode,
        recommended_display_cielab: [u16; 3],
    ) -> Self {
        Self {
            generation_type: GenerationType::Manual,
            algorithms: Vec::new(),
            category,
            property_type,
            property_type_modifiers: Vec::new(),
            anatomic_regions: Vec::new(),
            primary_anatomic_structures: Vec::new(),
            recommended_display_cielab,
        }
    }

    pub(crate) fn validate(&self) -> Result<()> {
        validate_generation(self.generation_type, &self.algorithms)
    }

    pub(crate) fn with_generation(
        mut self,
        generation_type: GenerationType,
        algorithms: Vec<AlgorithmIdentification>,
    ) -> Result<Self> {
        validate_generation(generation_type, &algorithms)?;
        self.generation_type = generation_type;
        self.algorithms = algorithms;
        Ok(self)
    }

    pub(crate) fn with_property_type_modifiers(mut self, modifiers: Vec<DicomCode>) -> Self {
        self.property_type_modifiers = modifiers;
        self
    }

    pub(crate) fn with_anatomic_regions(mut self, regions: Vec<DicomCode>) -> Self {
        self.anatomic_regions = regions;
        self
    }

    pub(crate) fn with_primary_anatomic_structures(mut self, structures: Vec<DicomCode>) -> Self {
        self.primary_anatomic_structures = structures;
        self
    }

    pub(crate) const fn generation_type(&self) -> GenerationType {
        self.generation_type
    }

    pub(crate) fn algorithms(&self) -> &[AlgorithmIdentification] {
        &self.algorithms
    }

    pub(crate) fn category(&self) -> &DicomCode {
        &self.category
    }

    pub(crate) fn property_type(&self) -> &DicomCode {
        &self.property_type
    }

    pub(crate) fn property_type_modifiers(&self) -> &[DicomCode] {
        &self.property_type_modifiers
    }

    pub(crate) fn anatomic_regions(&self) -> &[DicomCode] {
        &self.anatomic_regions
    }

    pub(crate) fn primary_anatomic_structures(&self) -> &[DicomCode] {
        &self.primary_anatomic_structures
    }

    pub(crate) const fn recommended_display_cielab(&self) -> [u16; 3] {
        self.recommended_display_cielab
    }
}

#[cfg(test)]
#[path = "finding_tests.rs"]
mod tests;