Skip to content

Result Types

This section covers the result types returned by each visualizer.

Type Module

imvf.type

VisualizationResult

Bases: BaseModel

Base class for visualization results.

This class provides common functionality for all visualization results, including validation and immutability.

Source code in src/imvf/type.py 
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
class VisualizationResult(BaseModel):
    """Base class for visualization results.

    This class provides common functionality for all visualization results,
    including validation and immutability.
    """

    model_config = ConfigDict(
        frozen=True,  # Make instances immutable
        arbitrary_types_allowed=True,  # Allow NumPy arrays
    )

    @field_validator("*", mode="before")
    @classmethod
    def _validate_numpy_array(cls, v: Any) -> ImageArray:
        """Validate NumPy array with uint8 dtype and 2D/3D shape.

        Args:
            v: The value to validate.

        Returns:
            The validated NumPy array with dtype uint8.

        Raises:
            ValueError: If validation fails.
        """
        if not isinstance(v, np.ndarray):
            raise ValueError(f"Expected numpy.ndarray, got {type(v).__name__}")

        if v.dtype != np.uint8:
            raise ValueError(f"Expected dtype uint8, got {v.dtype}")

        if v.ndim not in (2, 3):
            raise ValueError(f"Expected 2D or 3D array, got {v.ndim}D")

        return v

ColorChannelResult

Bases: VisualizationResult

A Pydantic model for storing color channel results.

Attributes:

Name Type Description
blue ImageArray

Blue channel as uint8 array.
green ImageArray

Green channel as uint8 array.
red ImageArray

Red channel as uint8 array.
Source code in src/imvf/type.py 
57
58
59
60
61
62
63
64
65
66
67
68
class ColorChannelResult(VisualizationResult):
    """A Pydantic model for storing color channel results.

    Attributes:
        blue: Blue channel as uint8 array.
        green: Green channel as uint8 array.
        red: Red channel as uint8 array.
    """

    blue: ImageArray
    green: ImageArray
    red: ImageArray

GradientResult

Bases: VisualizationResult

A Pydantic model for storing gradient results.

Attributes:

Name Type Description
gradient_x ImageArray

Gradient in x direction as uint8 array.
gradient_y ImageArray

Gradient in y direction as uint8 array.
gradient_xy ImageArray

Gradient in xy direction as uint8 array.
Source code in src/imvf/type.py 
71
72
73
74
75
76
77
78
79
80
81
82
class GradientResult(VisualizationResult):
    """A Pydantic model for storing gradient results.

    Attributes:
        gradient_x: Gradient in x direction as uint8 array.
        gradient_y: Gradient in y direction as uint8 array.
        gradient_xy: Gradient in xy direction as uint8 array.
    """

    gradient_x: ImageArray
    gradient_y: ImageArray
    gradient_xy: ImageArray

PowerSpectrumResult

Bases: VisualizationResult

A Pydantic model for storing power spectrum results.

Attributes:

Name Type Description
power_spectrum ImageArray

Power spectrum as uint8 array.
Source code in src/imvf/type.py 
85
86
87
88
89
90
91
92
class PowerSpectrumResult(VisualizationResult):
    """A Pydantic model for storing power spectrum results.

    Attributes:
        power_spectrum: Power spectrum as uint8 array.
    """

    power_spectrum: ImageArray

HogResult

Bases: VisualizationResult

A Pydantic model for storing Histogram of Oriented Gradient results.

Attributes:

Name Type Description
hog ImageArray

HoG features as uint8 array.
Source code in src/imvf/type.py 
 95
 96
 97
 98
 99
100
101
102
class HogResult(VisualizationResult):
    """A Pydantic model for storing Histogram of Oriented Gradient results.

    Attributes:
        hog: HoG features as uint8 array.
    """

    hog: ImageArray

LBPResult

Bases: VisualizationResult

A Pydantic model for storing Local Binary Pattern results.

Attributes:

Name Type Description
lbp ImageArray

LBP features as uint8 array.
Source code in src/imvf/type.py 
105
106
107
108
109
110
111
112
class LBPResult(VisualizationResult):
    """A Pydantic model for storing Local Binary Pattern results.

    Attributes:
        lbp: LBP features as uint8 array.
    """

    lbp: ImageArray

KeypointResult

Bases: VisualizationResult

A Pydantic model for storing keypoint results.

Attributes:

Name Type Description
keypoint ImageArray

Keypoint positions as uint8 array.
rich_keypoint ImageArray

Rich keypoint visualization as uint8 array.
Source code in src/imvf/type.py 
115
116
117
118
119
120
121
122
123
124
class KeypointResult(VisualizationResult):
    """A Pydantic model for storing keypoint results.

    Attributes:
        keypoint: Keypoint positions as uint8 array.
        rich_keypoint: Rich keypoint visualization as uint8 array.
    """

    keypoint: ImageArray
    rich_keypoint: ImageArray

options: show_root_heading: true show_source: true

ColorChannelResult

imvf.type.ColorChannelResult

Bases: VisualizationResult

A Pydantic model for storing color channel results.

Attributes:

Name Type Description
blue ImageArray

Blue channel as uint8 array.
green ImageArray

Green channel as uint8 array.
red ImageArray

Red channel as uint8 array.
Source code in src/imvf/type.py 
57
58
59
60
61
62
63
64
65
66
67
68
class ColorChannelResult(VisualizationResult):
    """A Pydantic model for storing color channel results.

    Attributes:
        blue: Blue channel as uint8 array.
        green: Green channel as uint8 array.
        red: Red channel as uint8 array.
    """

    blue: ImageArray
    green: ImageArray
    red: ImageArray

options: show_root_heading: true show_source: true

GradientResult

imvf.type.GradientResult

Bases: VisualizationResult

A Pydantic model for storing gradient results.

Attributes:

Name Type Description
gradient_x ImageArray

Gradient in x direction as uint8 array.
gradient_y ImageArray

Gradient in y direction as uint8 array.
gradient_xy ImageArray

Gradient in xy direction as uint8 array.
Source code in src/imvf/type.py 
71
72
73
74
75
76
77
78
79
80
81
82
class GradientResult(VisualizationResult):
    """A Pydantic model for storing gradient results.

    Attributes:
        gradient_x: Gradient in x direction as uint8 array.
        gradient_y: Gradient in y direction as uint8 array.
        gradient_xy: Gradient in xy direction as uint8 array.
    """

    gradient_x: ImageArray
    gradient_y: ImageArray
    gradient_xy: ImageArray

options: show_root_heading: true show_source: true

PowerSpectrumResult

imvf.type.PowerSpectrumResult

Bases: VisualizationResult

A Pydantic model for storing power spectrum results.

Attributes:

Name Type Description
power_spectrum ImageArray

Power spectrum as uint8 array.
Source code in src/imvf/type.py 
85
86
87
88
89
90
91
92
class PowerSpectrumResult(VisualizationResult):
    """A Pydantic model for storing power spectrum results.

    Attributes:
        power_spectrum: Power spectrum as uint8 array.
    """

    power_spectrum: ImageArray

options: show_root_heading: true show_source: true

HogResult

imvf.type.HogResult

Bases: VisualizationResult

A Pydantic model for storing Histogram of Oriented Gradient results.

Attributes:

Name Type Description
hog ImageArray

HoG features as uint8 array.
Source code in src/imvf/type.py 
 95
 96
 97
 98
 99
100
101
102
class HogResult(VisualizationResult):
    """A Pydantic model for storing Histogram of Oriented Gradient results.

    Attributes:
        hog: HoG features as uint8 array.
    """

    hog: ImageArray

options: show_root_heading: true show_source: true

LBPResult

imvf.type.LBPResult

Bases: VisualizationResult

A Pydantic model for storing Local Binary Pattern results.

Attributes:

Name Type Description
lbp ImageArray

LBP features as uint8 array.
Source code in src/imvf/type.py 
105
106
107
108
109
110
111
112
class LBPResult(VisualizationResult):
    """A Pydantic model for storing Local Binary Pattern results.

    Attributes:
        lbp: LBP features as uint8 array.
    """

    lbp: ImageArray

options: show_root_heading: true show_source: true

KeypointResult

imvf.type.KeypointResult

Bases: VisualizationResult

A Pydantic model for storing keypoint results.

Attributes:

Name Type Description
keypoint ImageArray

Keypoint positions as uint8 array.
rich_keypoint ImageArray

Rich keypoint visualization as uint8 array.
Source code in src/imvf/type.py 
115
116
117
118
119
120
121
122
123
124
class KeypointResult(VisualizationResult):
    """A Pydantic model for storing keypoint results.

    Attributes:
        keypoint: Keypoint positions as uint8 array.
        rich_keypoint: Rich keypoint visualization as uint8 array.
    """

    keypoint: ImageArray
    rich_keypoint: ImageArray

options: show_root_heading: true show_source: true