three.MF.V3.Tasks.HeatMap 

  1from MF.V3.Descriptors.HeatMap import HeatMap as MF_V3_Descriptors_HeatMap_HeatMap
  2from MF.V3.Settings.HeatMap import HeatMap as MF_V3_Settings_HeatMap_HeatMap
  3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
  4
  5
  6class HeatMap:
  7    """*
  8    Compute the point-to-mesh distances of a source mesh to a target mesh and visualize as a heat map.
  9
 10    > Request example:
 11
 12    ```json
 13    {
 14    "Task":{
 15    "Index":1,
 16    "Type":"HeatMap",
 17    "Input":{"sources":[2],"targets":[3]}
 18    }
 19    }
 20    ```
 21
 22    > Vertex position buffer message from server.
 23
 24    ```json
 25    {
 26    "Buffer":{
 27    "Index":0,
 28    "Size":1558188,
 29    "Descriptor":{
 30    "components":[{
 31    "type":"Position"
 32    "size":3,
 33    "offset":0,
 34    "normalized":false,
 35    }],
 36    "stride":3
 37    },
 38    "Task":{
 39    "Index":1,
 40    "Type":"HeatMap",
 41    "Input":{"sources":[2],"targets":[3]}
 42    }
 43    }
 44    }
 45    ```
 46
 47    > Vertex position binary data transfer from server [1558188 bytes].
 48
 49    > Vertex quality buffer message from server.
 50
 51    ```json
 52    {
 53    "Buffer":{
 54    "Index":0,
 55    "Size":1558188,
 56    "Descriptor":{
 57    "components":[{
 58    "type":"Quality"
 59    "size":3,
 60    "offset":0,
 61    "normalized":false,
 62    }],
 63    "stride":3
 64    },
 65    "Task":{
 66    "Index":1,
 67    "Type":"HeatMap",
 68    "Input":{"sources":[2],"targets":[3]}
 69    }
 70    }
 71    }
 72    ```
 73
 74    > Vertex quality binary data transfer from server [1558188 bytes].
 75
 76    > Triangle index buffer message from server.
 77
 78    ```json
 79    {
 80    "Buffer":{
 81    "Index":4,
 82    "Size":1996356,
 83    "Descriptor":{
 84    "components":[{
 85    "type":"Triangle"
 86    "size":1,
 87    "offset":0,
 88    "normalized":false,
 89    }],
 90    "stride":1
 91    },
 92    "Task":{
 93    "Index":1,
 94    "Type":"HeatMap",
 95    "Input":{"sources":[2],"targets":[3]}
 96    }
 97    }
 98    }
 99    ```
100
101    > Triangle index binary data transfer from server [1996356 bytes].
102
103    > Response example:
104
105    ```json
106    {
107    "Task":{
108    "Index":1,
109    "Type":"HeatMap",
110    "Input":{"sources":[2],"targets":[3]},
111    "Output":{
112    "count":96564,
113    "max":32.734107971191406,
114    "mean":1.964127540588379,
115    "median":0.12784385681152344,
116    "min":9.611248970031738e-07,
117    "outlierDistance":0.0,
118    "stddev":4.970643997192383
119    },
120    "State":"Completed"
121    }
122    }
123    ```
124    """
125    class Request:
126
127        """
128         Client request for the `HeatMap` task.
129        """
130        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap):
131            # A unique identifier generated by the client.
132            self.Index = Index
133            # "HeatMap"
134            self.Type = Type
135            # The heat map settings.
136            self.Input = Input
137
138    class Response:
139
140        """
141         Server response for the `HeatMap` task.
142        """
143        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap, Output: MF_V3_Descriptors_HeatMap_HeatMap, State: MF_V3_Task_TaskState = None, Error: str = None):
144            # The unique identifier generated by the client.
145            self.Index = Index
146            # "HeatMap"
147            self.Type = Type
148            # The requested heat map settings.
149            self.Input = Input
150            # The heat map descriptor.
151            self.Output = Output
152            # The current state of the task.
153            self.State = State
154            # A string describing the error if the task has failed.
155            self.Error = Error
156
157    def __init__(self):
158        pass
class HeatMap: 
  7class HeatMap:
  8    """*
  9    Compute the point-to-mesh distances of a source mesh to a target mesh and visualize as a heat map.
 10
 11    > Request example:
 12
 13    ```json
 14    {
 15    "Task":{
 16    "Index":1,
 17    "Type":"HeatMap",
 18    "Input":{"sources":[2],"targets":[3]}
 19    }
 20    }
 21    ```
 22
 23    > Vertex position buffer message from server.
 24
 25    ```json
 26    {
 27    "Buffer":{
 28    "Index":0,
 29    "Size":1558188,
 30    "Descriptor":{
 31    "components":[{
 32    "type":"Position"
 33    "size":3,
 34    "offset":0,
 35    "normalized":false,
 36    }],
 37    "stride":3
 38    },
 39    "Task":{
 40    "Index":1,
 41    "Type":"HeatMap",
 42    "Input":{"sources":[2],"targets":[3]}
 43    }
 44    }
 45    }
 46    ```
 47
 48    > Vertex position binary data transfer from server [1558188 bytes].
 49
 50    > Vertex quality buffer message from server.
 51
 52    ```json
 53    {
 54    "Buffer":{
 55    "Index":0,
 56    "Size":1558188,
 57    "Descriptor":{
 58    "components":[{
 59    "type":"Quality"
 60    "size":3,
 61    "offset":0,
 62    "normalized":false,
 63    }],
 64    "stride":3
 65    },
 66    "Task":{
 67    "Index":1,
 68    "Type":"HeatMap",
 69    "Input":{"sources":[2],"targets":[3]}
 70    }
 71    }
 72    }
 73    ```
 74
 75    > Vertex quality binary data transfer from server [1558188 bytes].
 76
 77    > Triangle index buffer message from server.
 78
 79    ```json
 80    {
 81    "Buffer":{
 82    "Index":4,
 83    "Size":1996356,
 84    "Descriptor":{
 85    "components":[{
 86    "type":"Triangle"
 87    "size":1,
 88    "offset":0,
 89    "normalized":false,
 90    }],
 91    "stride":1
 92    },
 93    "Task":{
 94    "Index":1,
 95    "Type":"HeatMap",
 96    "Input":{"sources":[2],"targets":[3]}
 97    }
 98    }
 99    }
100    ```
101
102    > Triangle index binary data transfer from server [1996356 bytes].
103
104    > Response example:
105
106    ```json
107    {
108    "Task":{
109    "Index":1,
110    "Type":"HeatMap",
111    "Input":{"sources":[2],"targets":[3]},
112    "Output":{
113    "count":96564,
114    "max":32.734107971191406,
115    "mean":1.964127540588379,
116    "median":0.12784385681152344,
117    "min":9.611248970031738e-07,
118    "outlierDistance":0.0,
119    "stddev":4.970643997192383
120    },
121    "State":"Completed"
122    }
123    }
124    ```
125    """
126    class Request:
127
128        """
129         Client request for the `HeatMap` task.
130        """
131        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap):
132            # A unique identifier generated by the client.
133            self.Index = Index
134            # "HeatMap"
135            self.Type = Type
136            # The heat map settings.
137            self.Input = Input
138
139    class Response:
140
141        """
142         Server response for the `HeatMap` task.
143        """
144        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap, Output: MF_V3_Descriptors_HeatMap_HeatMap, State: MF_V3_Task_TaskState = None, Error: str = None):
145            # The unique identifier generated by the client.
146            self.Index = Index
147            # "HeatMap"
148            self.Type = Type
149            # The requested heat map settings.
150            self.Input = Input
151            # The heat map descriptor.
152            self.Output = Output
153            # The current state of the task.
154            self.State = State
155            # A string describing the error if the task has failed.
156            self.Error = Error
157
158    def __init__(self):
159        pass

* Compute the point-to-mesh distances of a source mesh to a target mesh and visualize as a heat map.

Request example:

{
"Task":{
"Index":1,
"Type":"HeatMap",
"Input":{"sources":[2],"targets":[3]}
}
}

Vertex position buffer message from server.

{
"Buffer":{
"Index":0,
"Size":1558188,
"Descriptor":{
"components":[{
"type":"Position"
"size":3,
"offset":0,
"normalized":false,
}],
"stride":3
},
"Task":{
"Index":1,
"Type":"HeatMap",
"Input":{"sources":[2],"targets":[3]}
}
}
}

Vertex position binary data transfer from server [1558188 bytes].

Vertex quality buffer message from server.

{
"Buffer":{
"Index":0,
"Size":1558188,
"Descriptor":{
"components":[{
"type":"Quality"
"size":3,
"offset":0,
"normalized":false,
}],
"stride":3
},
"Task":{
"Index":1,
"Type":"HeatMap",
"Input":{"sources":[2],"targets":[3]}
}
}
}

Vertex quality binary data transfer from server [1558188 bytes].

Triangle index buffer message from server.

{
"Buffer":{
"Index":4,
"Size":1996356,
"Descriptor":{
"components":[{
"type":"Triangle"
"size":1,
"offset":0,
"normalized":false,
}],
"stride":1
},
"Task":{
"Index":1,
"Type":"HeatMap",
"Input":{"sources":[2],"targets":[3]}
}
}
}

Triangle index binary data transfer from server [1996356 bytes].

Response example:

{
"Task":{
"Index":1,
"Type":"HeatMap",
"Input":{"sources":[2],"targets":[3]},
"Output":{
"count":96564,
"max":32.734107971191406,
"mean":1.964127540588379,
"median":0.12784385681152344,
"min":9.611248970031738e-07,
"outlierDistance":0.0,
"stddev":4.970643997192383
},
"State":"Completed"
}
}
class HeatMap.Request: 
126    class Request:
127
128        """
129         Client request for the `HeatMap` task.
130        """
131        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap):
132            # A unique identifier generated by the client.
133            self.Index = Index
134            # "HeatMap"
135            self.Type = Type
136            # The heat map settings.
137            self.Input = Input

Client request for the HeatMap task.

HeatMap.Request(Index: int, Type: str, Input: MF.V3.Settings.HeatMap.HeatMap) 
131        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap):
132            # A unique identifier generated by the client.
133            self.Index = Index
134            # "HeatMap"
135            self.Type = Type
136            # The heat map settings.
137            self.Input = Input
Index
Type
Input
class HeatMap.Response: 
139    class Response:
140
141        """
142         Server response for the `HeatMap` task.
143        """
144        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap, Output: MF_V3_Descriptors_HeatMap_HeatMap, State: MF_V3_Task_TaskState = None, Error: str = None):
145            # The unique identifier generated by the client.
146            self.Index = Index
147            # "HeatMap"
148            self.Type = Type
149            # The requested heat map settings.
150            self.Input = Input
151            # The heat map descriptor.
152            self.Output = Output
153            # The current state of the task.
154            self.State = State
155            # A string describing the error if the task has failed.
156            self.Error = Error

Server response for the HeatMap task.

HeatMap.Response( Index: int, Type: str, Input: MF.V3.Settings.HeatMap.HeatMap, Output: MF.V3.Descriptors.HeatMap.HeatMap, State: MF.V3.Task.TaskState = None, Error: str = None) 
144        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_HeatMap_HeatMap, Output: MF_V3_Descriptors_HeatMap_HeatMap, State: MF_V3_Task_TaskState = None, Error: str = None):
145            # The unique identifier generated by the client.
146            self.Index = Index
147            # "HeatMap"
148            self.Type = Type
149            # The requested heat map settings.
150            self.Input = Input
151            # The heat map descriptor.
152            self.Output = Output
153            # The current state of the task.
154            self.State = State
155            # A string describing the error if the task has failed.
156            self.Error = Error
Index
Type
Input
Output
State
Error