three.MF.V3.Tasks.DepthMap 

  1from MF.V3.Descriptors.Image import Image as MF_V3_Descriptors_Image_Image
  2from MF.V3.Settings.Scan import Scan as MF_V3_Settings_Scan_Scan
  3from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
  4from typing import List
  5
  6
  7class DepthMap:
  8    """*
  9    Capture a new scan.
 10
 11    > Request example:
 12
 13    ```json
 14    {
 15    "Task":{
 16    "Index":1,
 17    "Type":"DepthMap"
 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    > Depth map buffer message from server.
 28
 29    ```json
 30    {
 31    "Buffer":{
 32    "Index":0,
 33    "Size":13128960,
 34    "Descriptor":{
 35    "cols":2104,
 36    "rows":1560,
 37    "step":8416,
 38    "type":5
 39    },
 40    "Task":{
 41    "Index":1,
 42    "Type":"DepthMap",
 43    "Input":{
 44    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 45    "capture":{"quality":"Medium","texture":true},
 46    "projector":{"brightness":0.8}
 47    }
 48    }
 49    }
 50    }
 51    ```
 52
 53    > Depth map binary data transfer from server [13128960 bytes].
 54
 55    > Texture buffer message from server.
 56
 57    ```json
 58    {
 59    "Buffer":{
 60    "Index":1,
 61    "Size":9846720,
 62    "Descriptor":{
 63    "cols":2104,
 64    "rows":1560,
 65    "step":6312,
 66    "type":16
 67    },
 68    "Task":{
 69    "Index":1,
 70    "Type":"DepthMap",
 71    "Input":{
 72    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 73    "capture":{"quality":"Medium","texture":true},
 74    "projector":{"brightness":0.8}
 75    }
 76    }
 77    }
 78    }
 79    ```
 80
 81    > Texture binary data transfer from server [9846720 bytes].
 82
 83    > Response example:
 84
 85    ```json
 86    {
 87    "Task":{
 88    "Index":1,
 89    "Type":"DepthMap"
 90    "Input":{
 91    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 92    "capture":{"quality":"Medium","texture":true},
 93    "projector":{"brightness":0.8}
 94    },
 95    "Output":[2500,0,1052,0,2500,780,0,0,1],
 96    "State":"Completed"
 97    }
 98    }
 99    ```
100    """
101    class Request:
102
103        """
104         Client request for the `DepthMap` task.
105        """
106        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
107            # A unique identifier generated by the client.
108            self.Index = Index
109            # "DepthMap"
110            self.Type = Type
111            # Scan settings.
112            self.Input = Input
113
114    class Response:
115
116        """
117         Server response for the `DepthMap` task.
118        """
119        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: List[float] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
120            # The unique identifier generated by the client.
121            self.Index = Index
122            # "DepthMap"
123            self.Type = Type
124            # Requested scan settings.
125            self.Input = Input
126            # The 9 values of the camera matrix corresponding to the depth map (row-major).
127            self.Output = Output
128            # The current state of the task.
129            self.State = State
130            # A string describing the error if the task has failed.
131            self.Error = Error
132
133    class Buffer:
134
135        """
136         Server buffer message for the `DepthMap` task.
137        """
138        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_Image_Image):
139            # The zero-based index identifying the data buffer.
140            self.Index = Index
141            # The size of the incoming data buffer in bytes.
142            self.Size = Size
143            # The requested DepthMap task.
144            self.Task = Task
145            # The image descriptor.
146            self.Descriptor = Descriptor
147
148    def __init__(self):
149        pass
class DepthMap: 
  8class DepthMap:
  9    """*
 10    Capture a new scan.
 11
 12    > Request example:
 13
 14    ```json
 15    {
 16    "Task":{
 17    "Index":1,
 18    "Type":"DepthMap"
 19    "Input":{
 20    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 21    "capture":{"quality":"Medium","texture":true},
 22    "projector":{"brightness":0.8}
 23    },
 24    }
 25    }
 26    ```
 27
 28    > Depth map buffer message from server.
 29
 30    ```json
 31    {
 32    "Buffer":{
 33    "Index":0,
 34    "Size":13128960,
 35    "Descriptor":{
 36    "cols":2104,
 37    "rows":1560,
 38    "step":8416,
 39    "type":5
 40    },
 41    "Task":{
 42    "Index":1,
 43    "Type":"DepthMap",
 44    "Input":{
 45    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 46    "capture":{"quality":"Medium","texture":true},
 47    "projector":{"brightness":0.8}
 48    }
 49    }
 50    }
 51    }
 52    ```
 53
 54    > Depth map binary data transfer from server [13128960 bytes].
 55
 56    > Texture buffer message from server.
 57
 58    ```json
 59    {
 60    "Buffer":{
 61    "Index":1,
 62    "Size":9846720,
 63    "Descriptor":{
 64    "cols":2104,
 65    "rows":1560,
 66    "step":6312,
 67    "type":16
 68    },
 69    "Task":{
 70    "Index":1,
 71    "Type":"DepthMap",
 72    "Input":{
 73    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 74    "capture":{"quality":"Medium","texture":true},
 75    "projector":{"brightness":0.8}
 76    }
 77    }
 78    }
 79    }
 80    ```
 81
 82    > Texture binary data transfer from server [9846720 bytes].
 83
 84    > Response example:
 85
 86    ```json
 87    {
 88    "Task":{
 89    "Index":1,
 90    "Type":"DepthMap"
 91    "Input":{
 92    "camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
 93    "capture":{"quality":"Medium","texture":true},
 94    "projector":{"brightness":0.8}
 95    },
 96    "Output":[2500,0,1052,0,2500,780,0,0,1],
 97    "State":"Completed"
 98    }
 99    }
100    ```
101    """
102    class Request:
103
104        """
105         Client request for the `DepthMap` task.
106        """
107        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
108            # A unique identifier generated by the client.
109            self.Index = Index
110            # "DepthMap"
111            self.Type = Type
112            # Scan settings.
113            self.Input = Input
114
115    class Response:
116
117        """
118         Server response for the `DepthMap` task.
119        """
120        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: List[float] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
121            # The unique identifier generated by the client.
122            self.Index = Index
123            # "DepthMap"
124            self.Type = Type
125            # Requested scan settings.
126            self.Input = Input
127            # The 9 values of the camera matrix corresponding to the depth map (row-major).
128            self.Output = Output
129            # The current state of the task.
130            self.State = State
131            # A string describing the error if the task has failed.
132            self.Error = Error
133
134    class Buffer:
135
136        """
137         Server buffer message for the `DepthMap` task.
138        """
139        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_Image_Image):
140            # The zero-based index identifying the data buffer.
141            self.Index = Index
142            # The size of the incoming data buffer in bytes.
143            self.Size = Size
144            # The requested DepthMap task.
145            self.Task = Task
146            # The image descriptor.
147            self.Descriptor = Descriptor
148
149    def __init__(self):
150        pass

* Capture a new scan.

Request example:

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

Depth map buffer message from server.

{
"Buffer":{
"Index":0,
"Size":13128960,
"Descriptor":{
"cols":2104,
"rows":1560,
"step":8416,
"type":5
},
"Task":{
"Index":1,
"Type":"DepthMap",
"Input":{
"camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
"capture":{"quality":"Medium","texture":true},
"projector":{"brightness":0.8}
}
}
}
}

Depth map binary data transfer from server [13128960 bytes].

Texture buffer message from server.

{
"Buffer":{
"Index":1,
"Size":9846720,
"Descriptor":{
"cols":2104,
"rows":1560,
"step":6312,
"type":16
},
"Task":{
"Index":1,
"Type":"DepthMap",
"Input":{
"camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
"capture":{"quality":"Medium","texture":true},
"projector":{"brightness":0.8}
}
}
}
}

Texture binary data transfer from server [9846720 bytes].

Response example:

{
"Task":{
"Index":1,
"Type":"DepthMap"
"Input":{
"camera":{"exposure":18000,"analogGain":256,"digitalGain":256},
"capture":{"quality":"Medium","texture":true},
"projector":{"brightness":0.8}
},
"Output":[2500,0,1052,0,2500,780,0,0,1],
"State":"Completed"
}
}
class DepthMap.Request: 
102    class Request:
103
104        """
105         Client request for the `DepthMap` task.
106        """
107        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
108            # A unique identifier generated by the client.
109            self.Index = Index
110            # "DepthMap"
111            self.Type = Type
112            # Scan settings.
113            self.Input = Input

Client request for the DepthMap task.

DepthMap.Request(Index: int, Type: str, Input: MF.V3.Settings.Scan.Scan = None) 
107        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None):
108            # A unique identifier generated by the client.
109            self.Index = Index
110            # "DepthMap"
111            self.Type = Type
112            # Scan settings.
113            self.Input = Input
Index
Type
Input
class DepthMap.Response: 
115    class Response:
116
117        """
118         Server response for the `DepthMap` task.
119        """
120        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: List[float] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
121            # The unique identifier generated by the client.
122            self.Index = Index
123            # "DepthMap"
124            self.Type = Type
125            # Requested scan settings.
126            self.Input = Input
127            # The 9 values of the camera matrix corresponding to the depth map (row-major).
128            self.Output = Output
129            # The current state of the task.
130            self.State = State
131            # A string describing the error if the task has failed.
132            self.Error = Error

Server response for the DepthMap task.

DepthMap.Response( Index: int, Type: str, Input: MF.V3.Settings.Scan.Scan = None, Output: List[float] = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
120        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scan_Scan = None, Output: List[float] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
121            # The unique identifier generated by the client.
122            self.Index = Index
123            # "DepthMap"
124            self.Type = Type
125            # Requested scan settings.
126            self.Input = Input
127            # The 9 values of the camera matrix corresponding to the depth map (row-major).
128            self.Output = Output
129            # The current state of the task.
130            self.State = State
131            # A string describing the error if the task has failed.
132            self.Error = Error
Index
Type
Input
Output
State
Error
class DepthMap.Buffer: 
134    class Buffer:
135
136        """
137         Server buffer message for the `DepthMap` task.
138        """
139        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_Image_Image):
140            # The zero-based index identifying the data buffer.
141            self.Index = Index
142            # The size of the incoming data buffer in bytes.
143            self.Size = Size
144            # The requested DepthMap task.
145            self.Task = Task
146            # The image descriptor.
147            self.Descriptor = Descriptor

Server buffer message for the DepthMap task.

DepthMap.Buffer( Index: int, Size: int, Task: MF.V3.Task.Task, Descriptor: MF.V3.Descriptors.Image.Image) 
139        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_Image_Image):
140            # The zero-based index identifying the data buffer.
141            self.Index = Index
142            # The size of the incoming data buffer in bytes.
143            self.Size = Size
144            # The requested DepthMap task.
145            self.Task = Task
146            # The image descriptor.
147            self.Descriptor = Descriptor
Index
Size
Task
Descriptor