three.MF.V3.Descriptors.Calibration

View Source

 1from enum import Enum
 2from typing import List
 3
 4
 5class Quality(Enum):
 6
 7    """
 8     Calibration quality.
 9    """
10    Empty = "None"  # The calibration does not exist.
11    Poor = "Poor"  # Poor calibration quality.
12    Fair = "Fair"  # Fair calibration quality.
13    Good = "Good"  # Good calibration quality.
14    Excellent = "Excellent"  # Excellent calibration quality.
15
16
17class Camera:
18
19    """
20     Camera calibration descriptor.
21    """
22    def __init__(self, quality: 'Quality', date: List[int] = None):
23        # Calibration quality.
24        self.quality = quality
25        # Calibration date and time [year, month, day, hour, minute, second].
26        self.date = date
27
28
29class Turntable:
30
31    """
32     Turntable calibration descriptor.
33    """
34    def __init__(self, quality: 'Quality', date: List[int] = None, focus: List[int] = None):
35        # Calibration quality.
36        self.quality = quality
37        # Calibration date and time [year, month, day, hour, minute, second].
38        self.date = date
39        # Focus values of each camera during calibration.
40        self.focus = focus
41
42
43class CaptureTarget:
44    """
45    Calibration capture target.
46
47    The camera calibration capture targets are used to draw quad overlays on the video stream to guide a user as to where to position the calibration card for each capture during camera calibration.
48    """
49    def __init__(self, camera: int, quads: List[float] = None):
50        # Index of the camera that is displayed to the user for this capture.
51        self.camera = camera
52        """
53        The target quad for each camera.
54        This is a set of 16 numbers defining the quad coordinates on the left and right camera.
55        The first 4 pairs of numbers define the quad on the left camera.
56        The last 4 pairs of numbers define the quad on the right camera.
57        """
58        self.quads = quads
59
60
61class DetectedCard:
62
63    """
64     Detected calibration card descriptor.
65    """
66    class Target:
67
68        """
69         Calibration capture target properties.
70        """
71        def __init__(self, match: float, hold: float):
72            """
73            A normalized value indicating how closely the calibration card matches the target
74            overlay. 0 indicates a poor match.  1 indicates a good match.
75            """
76            self.match = match
77            """
78            A normalized value indicating how long the user has held the calibration card steady over
79            the target overlay. When the value reaches 1, the user has held the calibration card
80            steady for the complete required duration.
81            """
82            self.hold = hold
83
84    def __init__(self, size: List[int] = None, quad: List[float] = None, corners: List[float] = None, target: 'Target' = None):
85        # The calibration card columns and rows.
86        self.size = size
87        # The calibration card bounding quadrilateral.
88        self.quad = quad
89        # The detected corners of the calibration card.
90        self.corners = corners
91        # The capture target properties, if a capture target is specified.
92        self.target = target

class Quality(enum.Enum): View Source

 6class Quality(Enum):
 7
 8    """
 9     Calibration quality.
10    """
11    Empty = "None"  # The calibration does not exist.
12    Poor = "Poor"  # Poor calibration quality.
13    Fair = "Fair"  # Fair calibration quality.
14    Good = "Good"  # Good calibration quality.
15    Excellent = "Excellent"  # Excellent calibration quality.

Calibration quality.

Empty = <Quality.Empty: 'None'>

Poor = <Quality.Poor: 'Poor'>

Fair = <Quality.Fair: 'Fair'>

Good = <Quality.Good: 'Good'>

Excellent = <Quality.Excellent: 'Excellent'>

class Camera: View Source

18class Camera:
19
20    """
21     Camera calibration descriptor.
22    """
23    def __init__(self, quality: 'Quality', date: List[int] = None):
24        # Calibration quality.
25        self.quality = quality
26        # Calibration date and time [year, month, day, hour, minute, second].
27        self.date = date

Camera calibration descriptor.

Camera( quality: Quality, date: List[int] = None) View Source

23    def __init__(self, quality: 'Quality', date: List[int] = None):
24        # Calibration quality.
25        self.quality = quality
26        # Calibration date and time [year, month, day, hour, minute, second].
27        self.date = date

quality

date

class Turntable: View Source

30class Turntable:
31
32    """
33     Turntable calibration descriptor.
34    """
35    def __init__(self, quality: 'Quality', date: List[int] = None, focus: List[int] = None):
36        # Calibration quality.
37        self.quality = quality
38        # Calibration date and time [year, month, day, hour, minute, second].
39        self.date = date
40        # Focus values of each camera during calibration.
41        self.focus = focus

Turntable calibration descriptor.

Turntable( quality: Quality, date: List[int] = None, focus: List[int] = None) View Source

35    def __init__(self, quality: 'Quality', date: List[int] = None, focus: List[int] = None):
36        # Calibration quality.
37        self.quality = quality
38        # Calibration date and time [year, month, day, hour, minute, second].
39        self.date = date
40        # Focus values of each camera during calibration.
41        self.focus = focus

quality

date

focus

class CaptureTarget: View Source

44class CaptureTarget:
45    """
46    Calibration capture target.
47
48    The camera calibration capture targets are used to draw quad overlays on the video stream to guide a user as to where to position the calibration card for each capture during camera calibration.
49    """
50    def __init__(self, camera: int, quads: List[float] = None):
51        # Index of the camera that is displayed to the user for this capture.
52        self.camera = camera
53        """
54        The target quad for each camera.
55        This is a set of 16 numbers defining the quad coordinates on the left and right camera.
56        The first 4 pairs of numbers define the quad on the left camera.
57        The last 4 pairs of numbers define the quad on the right camera.
58        """
59        self.quads = quads

Calibration capture target.

The camera calibration capture targets are used to draw quad overlays on the video stream to guide a user as to where to position the calibration card for each capture during camera calibration.

CaptureTarget(camera: int, quads: List[float] = None) View Source

50    def __init__(self, camera: int, quads: List[float] = None):
51        # Index of the camera that is displayed to the user for this capture.
52        self.camera = camera
53        """
54        The target quad for each camera.
55        This is a set of 16 numbers defining the quad coordinates on the left and right camera.
56        The first 4 pairs of numbers define the quad on the left camera.
57        The last 4 pairs of numbers define the quad on the right camera.
58        """
59        self.quads = quads

camera

The target quad for each camera. This is a set of 16 numbers defining the quad coordinates on the left and right camera. The first 4 pairs of numbers define the quad on the left camera. The last 4 pairs of numbers define the quad on the right camera.

quads

class DetectedCard: View Source

62class DetectedCard:
63
64    """
65     Detected calibration card descriptor.
66    """
67    class Target:
68
69        """
70         Calibration capture target properties.
71        """
72        def __init__(self, match: float, hold: float):
73            """
74            A normalized value indicating how closely the calibration card matches the target
75            overlay. 0 indicates a poor match.  1 indicates a good match.
76            """
77            self.match = match
78            """
79            A normalized value indicating how long the user has held the calibration card steady over
80            the target overlay. When the value reaches 1, the user has held the calibration card
81            steady for the complete required duration.
82            """
83            self.hold = hold
84
85    def __init__(self, size: List[int] = None, quad: List[float] = None, corners: List[float] = None, target: 'Target' = None):
86        # The calibration card columns and rows.
87        self.size = size
88        # The calibration card bounding quadrilateral.
89        self.quad = quad
90        # The detected corners of the calibration card.
91        self.corners = corners
92        # The capture target properties, if a capture target is specified.
93        self.target = target

Detected calibration card descriptor.

DetectedCard( size: List[int] = None, quad: List[float] = None, corners: List[float] = None, target: DetectedCard.Target = None) View Source

85    def __init__(self, size: List[int] = None, quad: List[float] = None, corners: List[float] = None, target: 'Target' = None):
86        # The calibration card columns and rows.
87        self.size = size
88        # The calibration card bounding quadrilateral.
89        self.quad = quad
90        # The detected corners of the calibration card.
91        self.corners = corners
92        # The capture target properties, if a capture target is specified.
93        self.target = target

size

quad

corners

target

class DetectedCard.Target: View Source

67    class Target:
68
69        """
70         Calibration capture target properties.
71        """
72        def __init__(self, match: float, hold: float):
73            """
74            A normalized value indicating how closely the calibration card matches the target
75            overlay. 0 indicates a poor match.  1 indicates a good match.
76            """
77            self.match = match
78            """
79            A normalized value indicating how long the user has held the calibration card steady over
80            the target overlay. When the value reaches 1, the user has held the calibration card
81            steady for the complete required duration.
82            """
83            self.hold = hold

Calibration capture target properties.

DetectedCard.Target(match: float, hold: float) View Source

72        def __init__(self, match: float, hold: float):
73            """
74            A normalized value indicating how closely the calibration card matches the target
75            overlay. 0 indicates a poor match.  1 indicates a good match.
76            """
77            self.match = match
78            """
79            A normalized value indicating how long the user has held the calibration card steady over
80            the target overlay. When the value reaches 1, the user has held the calibration card
81            steady for the complete required duration.
82            """
83            self.hold = hold

A normalized value indicating how closely the calibration card matches the target overlay. 0 indicates a poor match. 1 indicates a good match.

match

A normalized value indicating how long the user has held the calibration card steady over the target overlay. When the value reaches 1, the user has held the calibration card steady for the complete required duration.

hold