three.MF.V3.Tasks.NewScan 

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Settings.Scan import Scan as MF_V3_Settings_Scan_Scan
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class NewScan:
 7    """*
 8    Capture a new scan.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"NewScan"
17    "Input":{
18    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
19    "capture":{"quality":"Medium","texture":true},
20    "projector":{"brightness":0.8}
21    },
22    }
23    }
24    ```
25
26    > Response example:
27
28    ```json
29    {
30    "Task":{
31    "Index":1,
32    "Type":"NewScan"
33    "Input":{
34    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
35    "capture":{"quality":"Medium","texture":true},
36    "projector":{"brightness":0.8}
37    },
38    "Output":{
39    "groups":[{
40    "color":[0.8,0.5,0.6,1.0],
41    "index":1,
42    "name":"Scan-1",
43    "scan":1,
44    "rotation":[0.2,0.8,-0.1],
45    "translation":[-275,-32,-134],
46    "visible":true
47    }],
48    },
49    "State":"Completed"
50    }
51    }
52    ```
53    """
54    class Request:
55
56        """
57         Client request for the `NewScan` task.
58        """
59        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "NewScan"
63            self.Type = Type
64            # Scan settings.
65            self.Input = Input
66
67    class Response:
68
69        """
70         Server response for the `NewScan` task.
71        """
72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: MF_V3_Descriptors_Project_Project.Group = None, State: MF_V3_Task_TaskState = None, Error: str = None):
73            # The unique identifier generated by the client.
74            self.Index = Index
75            # "NewScan"
76            self.Type = Type
77            # Requested scan settings.
78            self.Input = Input
79            # Project group descriptor with the updated list of scans.
80            self.Output = Output
81            # The current state of the task.
82            self.State = State
83            # A string describing the error if the task has failed.
84            self.Error = Error
85
86    def __init__(self):
87        pass
class NewScan: 
 7class NewScan:
 8    """*
 9    Capture a new scan.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"NewScan"
18    "Input":{
19    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
20    "capture":{"quality":"Medium","texture":true},
21    "projector":{"brightness":0.8}
22    },
23    }
24    }
25    ```
26
27    > Response example:
28
29    ```json
30    {
31    "Task":{
32    "Index":1,
33    "Type":"NewScan"
34    "Input":{
35    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
36    "capture":{"quality":"Medium","texture":true},
37    "projector":{"brightness":0.8}
38    },
39    "Output":{
40    "groups":[{
41    "color":[0.8,0.5,0.6,1.0],
42    "index":1,
43    "name":"Scan-1",
44    "scan":1,
45    "rotation":[0.2,0.8,-0.1],
46    "translation":[-275,-32,-134],
47    "visible":true
48    }],
49    },
50    "State":"Completed"
51    }
52    }
53    ```
54    """
55    class Request:
56
57        """
58         Client request for the `NewScan` task.
59        """
60        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
61            # A unique identifier generated by the client.
62            self.Index = Index
63            # "NewScan"
64            self.Type = Type
65            # Scan settings.
66            self.Input = Input
67
68    class Response:
69
70        """
71         Server response for the `NewScan` task.
72        """
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: MF_V3_Descriptors_Project_Project.Group = None, State: MF_V3_Task_TaskState = None, Error: str = None):
74            # The unique identifier generated by the client.
75            self.Index = Index
76            # "NewScan"
77            self.Type = Type
78            # Requested scan settings.
79            self.Input = Input
80            # Project group descriptor with the updated list of scans.
81            self.Output = Output
82            # The current state of the task.
83            self.State = State
84            # A string describing the error if the task has failed.
85            self.Error = Error
86
87    def __init__(self):
88        pass

* Capture a new scan.

Request example:

{
"Task":{
"Index":1,
"Type":"NewScan"
"Input":{
"camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
"capture":{"quality":"Medium","texture":true},
"projector":{"brightness":0.8}
},
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"NewScan"
"Input":{
"camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
"capture":{"quality":"Medium","texture":true},
"projector":{"brightness":0.8}
},
"Output":{
"groups":[{
"color":[0.8,0.5,0.6,1.0],
"index":1,
"name":"Scan-1",
"scan":1,
"rotation":[0.2,0.8,-0.1],
"translation":[-275,-32,-134],
"visible":true
}],
},
"State":"Completed"
}
}
class NewScan.Request: 
55    class Request:
56
57        """
58         Client request for the `NewScan` task.
59        """
60        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
61            # A unique identifier generated by the client.
62            self.Index = Index
63            # "NewScan"
64            self.Type = Type
65            # Scan settings.
66            self.Input = Input

Client request for the NewScan task.

NewScan.Request(Index: int, Type: str, Input: MF.V3.Settings.Scan.Scan = None) 
60        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
61            # A unique identifier generated by the client.
62            self.Index = Index
63            # "NewScan"
64            self.Type = Type
65            # Scan settings.
66            self.Input = Input
Index
Type
Input
class NewScan.Response: 
68    class Response:
69
70        """
71         Server response for the `NewScan` task.
72        """
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: MF_V3_Descriptors_Project_Project.Group = None, State: MF_V3_Task_TaskState = None, Error: str = None):
74            # The unique identifier generated by the client.
75            self.Index = Index
76            # "NewScan"
77            self.Type = Type
78            # Requested scan settings.
79            self.Input = Input
80            # Project group descriptor with the updated list of scans.
81            self.Output = Output
82            # The current state of the task.
83            self.State = State
84            # A string describing the error if the task has failed.
85            self.Error = Error

Server response for the NewScan task.

NewScan.Response( Index: int, Type: str, Input: MF.V3.Settings.Scan.Scan = None, Output: MF.V3.Descriptors.Project.Project.Group = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: MF_V3_Descriptors_Project_Project.Group = None, State: MF_V3_Task_TaskState = None, Error: str = None):
74            # The unique identifier generated by the client.
75            self.Index = Index
76            # "NewScan"
77            self.Type = Type
78            # Requested scan settings.
79            self.Input = Input
80            # Project group descriptor with the updated list of scans.
81            self.Output = Output
82            # The current state of the task.
83            self.State = State
84            # A string describing the error if the task has failed.
85            self.Error = Error
Index
Type
Input
Output
State
Error