three.MF.V3.Tasks.Align

 1from MF.V3.Descriptors.Transform import Transform as MF_V3_Descriptors_Transform_Transform
 2from MF.V3.Settings.Align import Align as MF_V3_Settings_Align_Align
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class Align:
 7    """*
 8    Align two scan groups.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"Align",
17    "Input":{
18    "source":1,
19    "target":2,
20    "rough":{"method": "FastGlobal"},
21    "fine":{"method": "ICP"}
22    }
23    }
24    }
25    ```
26
27    > Response example:
28
29    ```json
30    {
31    "Task":{
32    "Index":1,
33    "Type":"Align",
34    "Input":{
35    "source":1,
36    "target":2,
37    "rough":{"method": "FastGlobal"},
38    "fine":{"method": "ICP"}
39    },
40    "Output":{
41    "rotation":[0.2, 0.4, 0.6],
42    "translation":[11, -10, 24]
43    },
44    "State":"Completed"
45    }
46    }
47    ```
48    """
49    class Request:
50
51        """
52         Client request for the `Align` task.
53        """
54        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align):
55            # A unique identifier generated by the client.
56            self.Index = Index
57            # "Align"
58            self.Type = Type
59            # The align settings.
60            self.Input = Input
61
62    class Response:
63
64        """
65         Server response for the `Align` task.
66        """
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align, Output: MF_V3_Descriptors_Transform_Transform, State: MF_V3_Task_TaskState = None, Error: str = None):
68            # The unique identifier generated by the client.
69            self.Index = Index
70            # "Align"
71            self.Type = Type
72            # The requested align settings.
73            self.Input = Input
74            # The transform that aligns the source scan group to the target scan group.
75            self.Output = Output
76            # The current state of the task.
77            self.State = State
78            # A string describing the error if the task has failed.
79            self.Error = Error
80
81    def __init__(self):
82        pass
class Align:
 7class Align:
 8    """*
 9    Align two scan groups.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"Align",
18    "Input":{
19    "source":1,
20    "target":2,
21    "rough":{"method": "FastGlobal"},
22    "fine":{"method": "ICP"}
23    }
24    }
25    }
26    ```
27
28    > Response example:
29
30    ```json
31    {
32    "Task":{
33    "Index":1,
34    "Type":"Align",
35    "Input":{
36    "source":1,
37    "target":2,
38    "rough":{"method": "FastGlobal"},
39    "fine":{"method": "ICP"}
40    },
41    "Output":{
42    "rotation":[0.2, 0.4, 0.6],
43    "translation":[11, -10, 24]
44    },
45    "State":"Completed"
46    }
47    }
48    ```
49    """
50    class Request:
51
52        """
53         Client request for the `Align` task.
54        """
55        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align):
56            # A unique identifier generated by the client.
57            self.Index = Index
58            # "Align"
59            self.Type = Type
60            # The align settings.
61            self.Input = Input
62
63    class Response:
64
65        """
66         Server response for the `Align` task.
67        """
68        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align, Output: MF_V3_Descriptors_Transform_Transform, State: MF_V3_Task_TaskState = None, Error: str = None):
69            # The unique identifier generated by the client.
70            self.Index = Index
71            # "Align"
72            self.Type = Type
73            # The requested align settings.
74            self.Input = Input
75            # The transform that aligns the source scan group to the target scan group.
76            self.Output = Output
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error
81
82    def __init__(self):
83        pass

* Align two scan groups.

Request example:

{
"Task":{
"Index":1,
"Type":"Align",
"Input":{
"source":1,
"target":2,
"rough":{"method": "FastGlobal"},
"fine":{"method": "ICP"}
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"Align",
"Input":{
"source":1,
"target":2,
"rough":{"method": "FastGlobal"},
"fine":{"method": "ICP"}
},
"Output":{
"rotation":[0.2, 0.4, 0.6],
"translation":[11, -10, 24]
},
"State":"Completed"
}
}
class Align.Request:
50    class Request:
51
52        """
53         Client request for the `Align` task.
54        """
55        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align):
56            # A unique identifier generated by the client.
57            self.Index = Index
58            # "Align"
59            self.Type = Type
60            # The align settings.
61            self.Input = Input

Client request for the Align task.

Align.Request(Index: int, Type: str, Input: MF.V3.Settings.Align.Align)
55        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align):
56            # A unique identifier generated by the client.
57            self.Index = Index
58            # "Align"
59            self.Type = Type
60            # The align settings.
61            self.Input = Input
Index
Type
Input
class Align.Response:
63    class Response:
64
65        """
66         Server response for the `Align` task.
67        """
68        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align, Output: MF_V3_Descriptors_Transform_Transform, State: MF_V3_Task_TaskState = None, Error: str = None):
69            # The unique identifier generated by the client.
70            self.Index = Index
71            # "Align"
72            self.Type = Type
73            # The requested align settings.
74            self.Input = Input
75            # The transform that aligns the source scan group to the target scan group.
76            self.Output = Output
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error

Server response for the Align task.

Align.Response( Index: int, Type: str, Input: MF.V3.Settings.Align.Align, Output: MF.V3.Descriptors.Transform.Transform, State: MF.V3.Task.TaskState = None, Error: str = None)
68        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Align_Align, Output: MF_V3_Descriptors_Transform_Transform, State: MF_V3_Task_TaskState = None, Error: str = None):
69            # The unique identifier generated by the client.
70            self.Index = Index
71            # "Align"
72            self.Type = Type
73            # The requested align settings.
74            self.Input = Input
75            # The transform that aligns the source scan group to the target scan group.
76            self.Output = Output
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error
Index
Type
Input
Output
State
Error