Skip to content

Template interface

ITemplate

Bases: ABC

Source code in src/officialeye/_api/template/template_interface.py 
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
class ITemplate(ABC):

    def __init__(self):
        super().__init__()

    @abstractmethod
    def load(self) -> None:
        """
        Loads the template into memory for further processing.

        If you prefer lazy-evaluation, do not call this method.
        Instead, run the desired operations with the template, and the necessary resources will be loaded on-the-fly.
        Use this method only if you really want to preload the template.
        """

        raise NotImplementedError()

    @abstractmethod
    def detect_async(self, /, *, target: IImage) -> Future:
        raise NotImplementedError()

    @abstractmethod
    def detect(self, /, **kwargs) -> ISupervisionResult:
        raise NotImplementedError()

    @abstractmethod
    def get_image(self) -> IImage:
        raise NotImplementedError()

    @abstractmethod
    def get_mutated_image(self) -> IImage:
        raise NotImplementedError()

    @property
    @abstractmethod
    def identifier(self) -> str:
        raise NotImplementedError()

    @property
    @abstractmethod
    def name(self) -> str:
        raise NotImplementedError()

    @property
    @abstractmethod
    def width(self) -> int:
        raise NotImplementedError()

    @property
    @abstractmethod
    def height(self) -> int:
        raise NotImplementedError()

    @property
    @abstractmethod
    def keypoints(self) -> Iterable[IKeypoint]:
        raise NotImplementedError()

    @property
    @abstractmethod
    def features(self) -> Iterable[IFeature]:
        raise NotImplementedError()

    @abstractmethod
    def get_feature(self, feature_id: str, /) -> IFeature | None:
        raise NotImplementedError()

    @abstractmethod
    def get_keypoint(self, keypoint_id: str, /) -> IKeypoint | None:
        raise NotImplementedError()

    def __str__(self) -> str:
        return f"Template '{self.identifier}'."

    def __eq__(self, o: Any) -> bool:

        if not isinstance(o, ITemplate):
            return False

        return self.identifier == o.identifier

    def __hash__(self):
        return hash(self.identifier)

load() abstractmethod

Loads the template into memory for further processing.

If you prefer lazy-evaluation, do not call this method. Instead, run the desired operations with the template, and the necessary resources will be loaded on-the-fly. Use this method only if you really want to preload the template.

Source code in src/officialeye/_api/template/template_interface.py 
16
17
18
19
20
21
22
23
24
25
26
@abstractmethod
def load(self) -> None:
    """
    Loads the template into memory for further processing.

    If you prefer lazy-evaluation, do not call this method.
    Instead, run the desired operations with the template, and the necessary resources will be loaded on-the-fly.
    Use this method only if you really want to preload the template.
    """

    raise NotImplementedError()