Merge pull request #18 from ImageMarkup/isic-162-add-tbp-tile-type

Author: danlamanna

isic_metadata/__init__.py

@@ -18,6 +18,7 @@
     MelType,
     NevusType,
     Sex,
+    TBPTileType,
 )
 
 try:
@@ -26,7 +27,6 @@
     # package is not installed
     pass
 
-
 FIELD_REGISTRY = {}
 
 for field in [
@@ -55,6 +55,7 @@
     ("nevus_type", NevusType),
     ("image_type", ImageType),
     ("dermoscopic_type", DermoscopicType),
+    ("tbp_tile_type", TBPTileType),
     ("mel_type", MelType),
     ("mel_class", MelClass),
     ("mel_mitotic_index", MelMitoticIndex),

isic_metadata/fields.py

@@ -211,6 +211,20 @@ def validate(cls, value: str) -> Optional[str]:
         return value
 
 
+class TBPTileTypeEnum(str, Enum):
+    tbp_3d_white = "3D: white"
+    tbp_3d_xp = "3D: XP"
+    tbp_2d = "2D"
+
+
+class TBPTileType(BaseStr):
+    @classmethod
+    def validate(cls, value: str) -> Optional[str]:
+        if value not in TBPTileTypeEnum._value2member_map_:
+            raise ValueError(f"Invalid TBP tile type of: {value}.")
+        return value
+
+
 class MelTypeEnum(str, Enum):
     superficial_spreading_melanoma = "superficial spreading melanoma"
     nodular_melanoma = "nodular melanoma"

isic_metadata/metadata.py

@@ -34,6 +34,7 @@
     MelTypeEnum,
     NevusTypeEnum,
     Sex,
+    TBPTileTypeEnum,
 )
 
 
@@ -123,6 +124,9 @@ class MetadataRow(BaseModel):
             DermoscopicTypeEnum, EnumErrorMessageValidator(DermoscopicTypeEnum, "dermoscopic_type")
         ]
     ] = None
+    tbp_tile_type: Optional[
+        Annotated[TBPTileTypeEnum, EnumErrorMessageValidator(TBPTileTypeEnum, "tbp_tile_type")]
+    ] = None
     anatom_site_general: Optional[
         Annotated[
             AnatomSiteGeneralEnum,
@@ -261,3 +265,17 @@ def validate_dermoscopic_fields(cls, v, info: FieldValidationInfo):
                 f"Image type {image_type or 'None'} inconsistent with dermoscopic type '{v.value}'."
             )
         return v
+
+    @field_validator("tbp_tile_type")
+    @classmethod
+    def validate_tbp_tile_fields(cls, v, info: FieldValidationInfo):
+        if (
+            info.data.get("image_type")
+            not in [ImageTypeEnum.tbp_tile_close_up, ImageTypeEnum.tbp_tile_overview]
+            and v
+        ):
+            image_type = info.data.get("tbp_tile_type", "")
+            raise ValueError(
+                f"Image type {image_type or 'None'} inconsistent with TBP tile type '{v.value}'."
+            )
+        return v

tests/test_dependent_fields.py

@@ -95,3 +95,13 @@ def test_dermoscopic_type_requires_image_type_dermoscopic():
     assert excinfo.value.errors()[0]["loc"][0] == "dermoscopic_type"
 
     MetadataRow(dermoscopic_type="contact polarized", image_type="dermoscopic")
+
+
+def test_tbp_tile_type_requires_image_type_tbp_tile():
+    with pytest.raises(ValidationError) as excinfo:
+        MetadataRow(tbp_tile_type="2D")
+    assert len(excinfo.value.errors()) == 1
+    assert excinfo.value.errors()[0]["loc"][0] == "tbp_tile_type"
+
+    MetadataRow(tbp_tile_type="2D", image_type="TBP tile: close-up")
+    MetadataRow(tbp_tile_type="2D", image_type="TBP tile: overview")