three.MF.V3.Tasks.CalibrateCameras 

 1from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 2
 3
 4class CalibrateCameras:
 5    """*
 6    Calibrate the cameras.
 7
 8    This task starts the camera calibration capture sequence where the user is guided to place the calibration card with a card outline drawn on the video feed.  Once each calibration card pose is captured, the cameras are calibrated and the calibration results are returned as a string.  If the cameras cannot be calibrated the task finishes in a `Failed` state.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"CalibrateCameras"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"CalibrateCameras",
28    "Output":"Camera calibration results: ...",
29    "State":"Completed"
30    }
31    }
32    ```
33    """
34    class Request:
35
36        """
37         Client request for the `CalibrateCameras` task.
38        """
39        def __init__(self, Index: int, Type: str):
40            # A unique identifier generated by the client.
41            self.Index = Index
42            # "CalibrateCameras"
43            self.Type = Type
44
45    class Response:
46
47        """
48         Server response for the `CalibrateCameras` task.
49        """
50        def __init__(self, Index: int, Type: str, Output: str = None, State: MF_V3_Task_TaskState = None, Error: str = None):
51            # The unique identifier generated by the client.
52            self.Index = Index
53            # "CalibrateCameras"
54            self.Type = Type
55            # Camera calibration results.
56            self.Output = Output
57            # The current state of the task.
58            self.State = State
59            # A string describing the error if the task has failed.
60            self.Error = Error
61
62    def __init__(self):
63        pass
class CalibrateCameras: 
 5class CalibrateCameras:
 6    """*
 7    Calibrate the cameras.
 8
 9    This task starts the camera calibration capture sequence where the user is guided to place the calibration card with a card outline drawn on the video feed.  Once each calibration card pose is captured, the cameras are calibrated and the calibration results are returned as a string.  If the cameras cannot be calibrated the task finishes in a `Failed` state.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"CalibrateCameras"
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"CalibrateCameras",
29    "Output":"Camera calibration results: ...",
30    "State":"Completed"
31    }
32    }
33    ```
34    """
35    class Request:
36
37        """
38         Client request for the `CalibrateCameras` task.
39        """
40        def __init__(self, Index: int, Type: str):
41            # A unique identifier generated by the client.
42            self.Index = Index
43            # "CalibrateCameras"
44            self.Type = Type
45
46    class Response:
47
48        """
49         Server response for the `CalibrateCameras` task.
50        """
51        def __init__(self, Index: int, Type: str, Output: str = None, State: MF_V3_Task_TaskState = None, Error: str = None):
52            # The unique identifier generated by the client.
53            self.Index = Index
54            # "CalibrateCameras"
55            self.Type = Type
56            # Camera calibration results.
57            self.Output = Output
58            # The current state of the task.
59            self.State = State
60            # A string describing the error if the task has failed.
61            self.Error = Error
62
63    def __init__(self):
64        pass

* Calibrate the cameras.

This task starts the camera calibration capture sequence where the user is guided to place the calibration card with a card outline drawn on the video feed. Once each calibration card pose is captured, the cameras are calibrated and the calibration results are returned as a string. If the cameras cannot be calibrated the task finishes in a Failed state.

Request example:

{
"Task":{
"Index":1,
"Type":"CalibrateCameras"
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"CalibrateCameras",
"Output":"Camera calibration results: ...",
"State":"Completed"
}
}
class CalibrateCameras.Request: 
35    class Request:
36
37        """
38         Client request for the `CalibrateCameras` task.
39        """
40        def __init__(self, Index: int, Type: str):
41            # A unique identifier generated by the client.
42            self.Index = Index
43            # "CalibrateCameras"
44            self.Type = Type

Client request for the CalibrateCameras task.

CalibrateCameras.Request(Index: int, Type: str) 
40        def __init__(self, Index: int, Type: str):
41            # A unique identifier generated by the client.
42            self.Index = Index
43            # "CalibrateCameras"
44            self.Type = Type
Index
Type
class CalibrateCameras.Response: 
46    class Response:
47
48        """
49         Server response for the `CalibrateCameras` task.
50        """
51        def __init__(self, Index: int, Type: str, Output: str = None, State: MF_V3_Task_TaskState = None, Error: str = None):
52            # The unique identifier generated by the client.
53            self.Index = Index
54            # "CalibrateCameras"
55            self.Type = Type
56            # Camera calibration results.
57            self.Output = Output
58            # The current state of the task.
59            self.State = State
60            # A string describing the error if the task has failed.
61            self.Error = Error

Server response for the CalibrateCameras task.

CalibrateCameras.Response( Index: int, Type: str, Output: str = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
51        def __init__(self, Index: int, Type: str, Output: str = None, State: MF_V3_Task_TaskState = None, Error: str = None):
52            # The unique identifier generated by the client.
53            self.Index = Index
54            # "CalibrateCameras"
55            self.Type = Type
56            # Camera calibration results.
57            self.Output = Output
58            # The current state of the task.
59            self.State = State
60            # A string describing the error if the task has failed.
61            self.Error = Error
Index
Type
Output
State
Error