Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
2ea49e60 by Mike Mathews
Options

Updated spec to comply with latest requirements and recommended changes.

1 parent e0ab40ea
Inline Side-by-side
Showing 1 changed file with 42 additions and 27 deletions
ILP/V1.2/IlpAnalysisApi.xid.xml
......@@ -77,7 +77,7 @@
-->
<struct name="Specification" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestSpecification">
<comment>Specification for an ILP Test comprising one or more data sets.</comment>
<elem name="createDate" type="datetime" multiplicity="1">
<comment>Date and time the test specification was created.</comment>
</elem>
......@@ -85,6 +85,14 @@
<elem name="modifiedDate" type="datetime" multiplicity="1">
<comment>Date and time the test specification was modified.</comment>
</elem>
<elem name="extendedResults" multiplicity=[1] type="bool" default="false">
<comment>
Specifies whether to provide extended test result records with state and velocity fields. By
default, this is false. This is typically used with GNSS data analysis, indoor analysis will rarely use
these fields.
</comment>
</elem>
<elem name="contact" multiplicity ="0..1" type="GeoSpatial.ContactInfo" >
<comment>Optional contact information.</comment>
......@@ -93,6 +101,8 @@
<elem name="datasets" multiplicity="0..*" type="DataSet">
<comment>Dataset specifications to process.</comment>
</elem>
</struct>
<!--
......@@ -101,28 +111,31 @@
*************************************
-->
<struct name="ResultRecord" >
<comment>Result Record contains detailed results of position calculation and information relative to truth.</comment>
<comment>Result Record contains detailed results of position calculation and information relative to truth. Optional fields will be included when
the Specification.extendedResults is true.</comment>
<elem name="index" type="uint32" multiplicity="1" />
<elem name="epoch" type="datetime" multiplicity="1" />
<elem name="resultcode" type="ResultCode" multiplicity="1" />
<elem name="status" type="HPE.ProcessingStatus" multiplicity="1" />
<elem name="source" type="string" multiplicity="1" />
<elem name="stateTruth" type="HPE.StateVector" multiplicity="1" />
<elem name="stateEst" type="HPE.StateVector" multiplicity="1" />
<elem name="stateUncert" type="HPE.StateVector" multiplicity="1" />
<elem name="stateErr" type="HPE.StateVector" multiplicity="1" />
<elem name="llaTruth" type="GeoSpatial.PositionECEF" multiplicity="1" />
<elem name="llaEst" type="GeoSpatial.PositionECEF" multiplicity="1" />
<elem name="enuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="enuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="enuEstVel" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="enuErrVel" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="veracity" type="float32" multiplicity="1" />
<elem name="floor" type="float32" multiplicity="1" />
<elem name="floorTruth" type="float32" multiplicity="1" />
<elem name="floorUncert" type="float32" multiplicity="1" />
<elem name="floorErr" type="float32" multiplicity="1" />
<elem name="floorLabel" type="string" multiplicity="1" />
<elem name="data" type="json" multiplicity="0..1" />
<elem name="veracity" type="float32" multiplicity="1" />
<elem name="enuVelEst" type="GeoSpatial.XYZVector" multiplicity="0..1" />
<elem name="enuVelErr" type="GeoSpatial.XYZVector" multiplicity="0..1" />
<elem name="stateTruth" type="HPE.StateVector" multiplicity="0..1" />
<elem name="stateEst" type="HPE.StateVector" multiplicity="0..1" />
<elem name="stateUncert" type="HPE.StateVector" multiplicity="0..1" />
<elem name="stateErr" type="HPE.StateVector" multiplicity="0..1" />
<elem name="miscdata" type="json" multiplicity="0..1" />
</struct>
<!--
......@@ -134,22 +147,24 @@
<comment>Calculated statistics for the associated the results.</comment>
<elem name="count" type="uint32" multiplicity="1" />
<elem name="outliers" type="uint32" multiplicity="1" />
<elem name="cep50" type="float32" multiplicity="1" />
<elem name="cep68" type="float32" multiplicity="1" />
<elem name="cep95" type="float32" multiplicity="1" />
<elem name="cepmax" type="float32" multiplicity="1" />
<elem name="rmsuncert" type="float32" multiplicity="1" />
<elem name="rmserr" type="float32" multiplicity="1" />
<elem name="meanState" type="HPE.StateVector" multiplicity="1" />
<elem name="meanStateErr" type="HPE.StateVector" multiplicity="1" />
<elem name="meanEnuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuVel" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuVelUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuVelErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="rmsEnuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="rmsEnuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanFloor" type="float32" multiplicity="1" />
<elem name="rmsFloorUncert" type="float32" multiplicity="1" />
<elem name="rmsFloorErr" type="float32" multiplicity="1" />
<elem name="meanEnuVel" type="GeoSpatial.XYZVector" multiplicity="0..1" />
<elem name="rmsEnuVelUncert" type="GeoSpatial.XYZVector" multiplicity="0..1" />
<elem name="rmsEnuVelErr" type="GeoSpatial.XYZVector" multiplicity="0..1" />
<elem name="meanState" type="HPE.StateVector" multiplicity="0..1" />
<elem name="rmsStateErr" type="HPE.StateVector" multiplicity="0..1" />
</struct>
<!--
......@@ -160,16 +175,8 @@
<struct name="ServiceResults" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestResultSet">
<comment>Specification for an ILP analysis test data result set.</comment>
<elem name="records" type="ResultRecord" multiplicity="0..*">
<comment>The estimated position result records.</comment>
</elem>
<elem name="stats" type="Statistics" multiplicity="1">
<comment>Statistics for the result set.</comment>
</elem>
<elem name="confidence" type="float32" multiplicity="1" >
<comment>Confidence for the result records. Typically this will be .6872, but will report the confidence specified by the input.</comment>
<comment>Confidence for the result records. Typically this will be one standard deviation (0.6872) but will report the confidence specified by the input.</comment>
</elem>
<elem name="uriService" multiplicity = "1" type="Tensor.uri">
......@@ -177,7 +184,15 @@
Analysis can comprise multiple services processing the datasets and producing reports that provide a comparative performance. Check the API documentation for
querying a list of available service URIs (e.g. ILPS, etc.).
</comment>
</elem>
</elem>
<elem name="stats" type="Statistics" multiplicity="1">
<comment>Statistics for the result set.</comment>
</elem>
<elem name="records" type="ResultRecord" multiplicity="0..*">
<comment>The estimated position result records.</comment>
</elem>
</struct>
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!