Skip to content

Internal feature

InternalFeature

Bases: InternalRegion, IFeature

Source code in src/officialeye/_internal/template/internal_feature.py 
 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
class InternalFeature(InternalRegion, IFeature):

    def __init__(self, template_id: str, feature_dict: Dict[str, any], /):
        super().__init__(template_id, feature_dict)

        if "class" in feature_dict:
            self._class_id = feature_dict["class"]
            assert isinstance(self._class_id, str)
        else:
            self._class_id = None

    def validate_feature_class(self):

        if self._class_id is None:
            return

        feature_classes: FeatureClassManager = self.template.get_feature_classes()

        if not feature_classes.contains_class(self._class_id):
            raise ErrTemplateInvalidFeature(
                f"while loading class for feature '{self.identifier}' in template '{self.template.identifier}'.",
                f"Specified feature class '{self._class_id}' is not defined."
            )

        feature_class = feature_classes.get_class(self._class_id)

        if feature_class.is_abstract():
            raise ErrTemplateInvalidFeature(
                f"while loading class for feature '{self.identifier}' in template '{self.template.identifier}'.",
                f"Cannot instantiate an abstract feature class '{self._class_id}'."
            )

    def get_feature_class(self) -> Union[FeatureClass, None]:
        """ Returns class of feature, or None if the feature does not have a class. """

        if self._class_id is None:
            return None

        feature_classes: FeatureClassManager = self.template.get_feature_classes()

        assert feature_classes.contains_class(self._class_id)

        feature_class = feature_classes.get_class(self._class_id)

        assert not feature_class.is_abstract()

        return feature_class

    def get_mutators(self) -> Iterable[IMutator]:

        feature_class = self.get_feature_class()

        if feature_class is None:
            return []

        mutators = feature_class.get_data()["mutators"]

        assert isinstance(mutators, list)

        return [
            load_mutator_from_dict(mutator_dict) for mutator_dict in mutators
        ]

    def interpret_image(self, img: np.ndarray, /) -> FeatureInterpretation:
        """
        Takes an image and runs the interpretation method defined in the corresponding feature class.
        Assumes that the feature class is present.

        Arguments:
            img: The image which should be passed to the intepretation method.

        Returns:
            The result of running the interpretation method on the image.
        """

        feature_class = self.get_feature_class()

        assert feature_class is not None

        interpretation_method_id = feature_class.get_data()["interpretation"]["method"]
        interpretation_method_config = feature_class.get_data()["interpretation"]["config"]

        assert isinstance(interpretation_method_id, str)
        assert isinstance(interpretation_method_config, dict)

        interpretation_method = get_internal_context().get_interpretation(interpretation_method_id, interpretation_method_config)

        return interpretation_method.interpret(img, self)

get_feature_class()

Returns class of feature, or None if the feature does not have a class.

Source code in src/officialeye/_internal/template/internal_feature.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def get_feature_class(self) -> Union[FeatureClass, None]:
    """ Returns class of feature, or None if the feature does not have a class. """

    if self._class_id is None:
        return None

    feature_classes: FeatureClassManager = self.template.get_feature_classes()

    assert feature_classes.contains_class(self._class_id)

    feature_class = feature_classes.get_class(self._class_id)

    assert not feature_class.is_abstract()

    return feature_class

interpret_image(img)

Takes an image and runs the interpretation method defined in the corresponding feature class. Assumes that the feature class is present.

Parameters:

Name Type Description Default
img ndarray

The image which should be passed to the intepretation method.

 required

Returns:

Type Description
FeatureInterpretation

The result of running the interpretation method on the image.
Source code in src/officialeye/_internal/template/internal_feature.py 
 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
def interpret_image(self, img: np.ndarray, /) -> FeatureInterpretation:
    """
    Takes an image and runs the interpretation method defined in the corresponding feature class.
    Assumes that the feature class is present.

    Arguments:
        img: The image which should be passed to the intepretation method.

    Returns:
        The result of running the interpretation method on the image.
    """

    feature_class = self.get_feature_class()

    assert feature_class is not None

    interpretation_method_id = feature_class.get_data()["interpretation"]["method"]
    interpretation_method_config = feature_class.get_data()["interpretation"]["config"]

    assert isinstance(interpretation_method_id, str)
    assert isinstance(interpretation_method_config, dict)

    interpretation_method = get_internal_context().get_interpretation(interpretation_method_id, interpretation_method_config)

    return interpretation_method.interpret(img, self)