Structure CalculateInput
Tensor.InputBase
┗ ILP.CalculateInput
namespace: ILP
packed: false
ILP.Positioning.Calculate input data structure.
Summary
rankEstimate, confidence, maxEstimates, typeShape, state, observations, obsSetXmfFmt, obsSetXmf
Field Detail
- rankEstimate (optional) : EstimateRanking
-
Specifies the sort order of the estimates produced by the hybrid calculation.
If not defined, the default value is to sort estimates based on calculation order (0).
- confidence (optional) : float32
-
Specifies the confidence level to report estimate error uncertainty, range between 0.0 and 1.0
Common values for confidence are:
0.682689 (1 std. dev.)
0.954499 (2 std. dev.)
0.997300 (3 std. dev.)
If confidence is not specified, the default value is 0.682689.
- maxEstimates (optional) : uint8
-
Specifies the maximum number of estimates (up to 255) to return in the calculation output. If not specified 1 hybrid estimate is returned.
- typeShape [zero or more] : ShapeType
-
Specifies the preferred shape types to provide estimates in. The highest ranking estimate will be returned in this specified shape types if supported. If not specified, the set defaults to: Spheroid, Circle.
- state (optional) : StateInfo
-
Specifies the position to initialize the state of the positioning engine. At least one of observations or state is required, otherwise there is insufficient data to process.
- observations (optional) : ObservationSet
-
Set of observation data comprising one ore At least one of observations, obsSetEncoded, or state is required, otherwise there is insufficient data to process.
- obsSetXmfFmt (optional) : EncodingFormat
-
XMF observation set encoding format. XMF Observations may be passed to the service in an encoding format different than the XNF, encoded in accordance to the format key defined by the this field. By default (0) is the native format XMF.
- obsSetXmf (optional) : xmf
-
Encoded observation set encoded in the format specified by "obsSetEncodedFmt". The base, 'native' format is XMF. At least one of observations, obsSetEncoded, or state is required, otherwise there is insufficient data to process. Encoded observations have a base format type of xmf, which may be further encoded with the user defined encoding.
Use this field to pass data in XMF or other encoded formats. This allows mixed format messages to be supported (e.g. JSON wrapper around XMF observations). To learn more about obtaining support for custom encoding formats, please contact site administrator for further information.