omidb.mark¶
-
class
omidb.mark.Mark(id: str, lesion_id: str, boundingBox: omidb.mark.BoundingBox, conspicuity: omidb.mark.Conspicuity, architectural_distortion: Optional[bool] = None, dystrophic_calcification: Optional[bool] = None, fat_necrosis: Optional[bool] = None, focal_asymmetry: Optional[bool] = None, mass: Optional[bool] = None, suspicious_calcifications: Optional[bool] = None, milk_of_calcium: Optional[bool] = None, other_benign_cluster: Optional[bool] = None, plasma_cell_mastitis: Optional[bool] = None, benign_skin_feature: Optional[bool] = None, calcifications: Optional[bool] = None, suture_calcification: Optional[bool] = None, vascular_feature: Optional[bool] = None, benign_classification: Optional[omidb.mark.BenignClassification] = None, mass_classification: Optional[omidb.mark.MassClassification] = None)[source]¶ A ground-truth region of interest made by an expert radiologist. A mark includes the region of interest and descriptions characterising the lesion.
Note that boolean attributes default to
None, rather thanFalse, to reduce misinterpretation when the source attribute has not been set by the Radiologist. Interpret as ‘no value’.- Parameters
id (
str) – An identifier for the annotationlesion_id (
str) – An identifier for the lesion associated with this mark; unique within episode only. Corresponds to the LinkedNBSSLesionNumber field of the ImageDB JSON, which itself maps to the key of the lesion referenced by the NBSS JSON.boundingBox (
BoundingBox) – 2D coordinates defining the lower-left (x1, y1) and upper-right (x2, y2) corners of the markconspicuity (
Conspicuity) – Enumeration indicating mark conspicuityarchitectural_distortion (
Optional[bool]) – The mark highlights architectural distortiondystrophic_calcification (
Optional[bool]) – The mark highlights dystrophic calcificationfat_necrosis (
Optional[bool]) – The mark highlights an area of fat necrosisfocal_asymmetry (
Optional[bool]) – Indicates focal asymmetrymass (
Optional[bool]) – The marked lesion is a masssuspicious_calcifications (
Optional[bool]) – Indicates a suspicious calcification clustermilk_of_calcium (
Optional[bool]) – The mark highlights milk of calcium mammographic featuresother_benign_cluster (
Optional[bool]) – The mark surrounds a benign calcification cluster not described by other parametersplasma_cell_mastitis (
Optional[bool]) – The marked area indicates plasma-cell-mastitisbenign_skin_feature (
Optional[bool]) – The mark captures a benign skin lesion, calcified or othercalcifications (
Optional[bool]) – The marked area has calcificationssuture_calcification (
Optional[bool]) – The marked area indicates suture calcificationsvascular_feature (
Optional[bool]) – The marked area indicates vascular calcificationsbenign_classification (
Optional[BenignClassification]) – Enumeration describing the benign featuremass_classification (
Optional[MassClassification]) – Enumeration describing the mass border
-
class
omidb.mark.BoundingBox(x1: int, y1: int, x2: int, y2: int)[source]¶ 2D coordinates defining the mark
-
class
omidb.mark.Conspicuity[source]¶ Indicates this marks conspicuity
-
not_recalled= 'not_recalled'¶
-
obvious= 'Obvious'¶
-
occult= 'Occult'¶
-
subtle= 'Subtle'¶
-
very_subtle= 'Very_subtle'¶
-
-
class
omidb.mark.BenignClassification[source]¶ Description of the benign feature
-
coarse= 'coarse_or_popcorn-like'¶
-
egg_shell= 'egg_shell_or_rim'¶
-
lucent_centred= 'lucent-centred'¶
-
rod= 'rod-like'¶
-
round_puncate= 'round_and_punctate'¶
-
-
class
omidb.mark.MassClassification[source]¶ Description of the mass border
-
course= 'coarse_or_popcorn-like'¶
-
egg_shell= 'egg_shell_or_rim'¶
-
ill_defined= 'ill_defined'¶
-
lucent_centred= 'lucent-centred'¶
-
other= 'other'¶
-
spiculated= 'spiculated'¶
-
unknown= 'unknown'¶
-
well_defined= 'well_defined'¶
-