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 @@ ...@@ -77,7 +77,7 @@
77 --> 77 -->
78 <struct name="Specification" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestSpecification"> 78 <struct name="Specification" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestSpecification">
79 <comment>Specification for an ILP Test comprising one or more data sets.</comment> 79 <comment>Specification for an ILP Test comprising one or more data sets.</comment>
80 80
81 <elem name="createDate" type="datetime" multiplicity="1"> 81 <elem name="createDate" type="datetime" multiplicity="1">
82 <comment>Date and time the test specification was created.</comment> 82 <comment>Date and time the test specification was created.</comment>
83 </elem> 83 </elem>
...@@ -85,6 +85,14 @@ ...@@ -85,6 +85,14 @@
85 <elem name="modifiedDate" type="datetime" multiplicity="1"> 85 <elem name="modifiedDate" type="datetime" multiplicity="1">
86 <comment>Date and time the test specification was modified.</comment> 86 <comment>Date and time the test specification was modified.</comment>
87 </elem> 87 </elem>
88
89 <elem name="extendedResults" multiplicity=[1] type="bool" default="false">
90 <comment>
91 Specifies whether to provide extended test result records with state and velocity fields. By
92 default, this is false. This is typically used with GNSS data analysis, indoor analysis will rarely use
93 these fields.
94 </comment>
95 </elem>
88 96
89 <elem name="contact" multiplicity ="0..1" type="GeoSpatial.ContactInfo" > 97 <elem name="contact" multiplicity ="0..1" type="GeoSpatial.ContactInfo" >
90 <comment>Optional contact information.</comment> 98 <comment>Optional contact information.</comment>
...@@ -93,6 +101,8 @@ ...@@ -93,6 +101,8 @@
93 <elem name="datasets" multiplicity="0..*" type="DataSet"> 101 <elem name="datasets" multiplicity="0..*" type="DataSet">
94 <comment>Dataset specifications to process.</comment> 102 <comment>Dataset specifications to process.</comment>
95 </elem> 103 </elem>
104
105
96 </struct> 106 </struct>
97 107
98 <!-- 108 <!--
...@@ -101,28 +111,31 @@ ...@@ -101,28 +111,31 @@
101 ************************************* 111 *************************************
102 --> 112 -->
103 <struct name="ResultRecord" > 113 <struct name="ResultRecord" >
104 <comment>Result Record contains detailed results of position calculation and information relative to truth.</comment> 114 <comment>Result Record contains detailed results of position calculation and information relative to truth. Optional fields will be included when
115 the Specification.extendedResults is true.</comment>
105 116
106 <elem name="index" type="uint32" multiplicity="1" /> 117 <elem name="index" type="uint32" multiplicity="1" />
107 <elem name="epoch" type="datetime" multiplicity="1" /> 118 <elem name="epoch" type="datetime" multiplicity="1" />
108 <elem name="resultcode" type="ResultCode" multiplicity="1" /> 119 <elem name="resultcode" type="ResultCode" multiplicity="1" />
109 <elem name="status" type="HPE.ProcessingStatus" multiplicity="1" /> 120 <elem name="status" type="HPE.ProcessingStatus" multiplicity="1" />
110 <elem name="source" type="string" multiplicity="1" /> 121 <elem name="source" type="string" multiplicity="1" />
111 <elem name="stateTruth" type="HPE.StateVector" multiplicity="1" />
112 <elem name="stateEst" type="HPE.StateVector" multiplicity="1" />
113 <elem name="stateUncert" type="HPE.StateVector" multiplicity="1" />
114 <elem name="stateErr" type="HPE.StateVector" multiplicity="1" />
115 <elem name="llaTruth" type="GeoSpatial.PositionECEF" multiplicity="1" /> 122 <elem name="llaTruth" type="GeoSpatial.PositionECEF" multiplicity="1" />
116 <elem name="llaEst" type="GeoSpatial.PositionECEF" multiplicity="1" /> 123 <elem name="llaEst" type="GeoSpatial.PositionECEF" multiplicity="1" />
124 <elem name="enuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
117 <elem name="enuErr" type="GeoSpatial.XYZVector" multiplicity="1" /> 125 <elem name="enuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
118 <elem name="enuEstVel" type="GeoSpatial.XYZVector" multiplicity="1" />
119 <elem name="enuErrVel" type="GeoSpatial.XYZVector" multiplicity="1" />
120 <elem name="veracity" type="float32" multiplicity="1" />
121 <elem name="floor" type="float32" multiplicity="1" /> 126 <elem name="floor" type="float32" multiplicity="1" />
127 <elem name="floorTruth" type="float32" multiplicity="1" />
122 <elem name="floorUncert" type="float32" multiplicity="1" /> 128 <elem name="floorUncert" type="float32" multiplicity="1" />
123 <elem name="floorErr" type="float32" multiplicity="1" /> 129 <elem name="floorErr" type="float32" multiplicity="1" />
124 <elem name="floorLabel" type="string" multiplicity="1" /> 130 <elem name="floorLabel" type="string" multiplicity="1" />
125 <elem name="data" type="json" multiplicity="0..1" /> 131 <elem name="veracity" type="float32" multiplicity="1" />
132 <elem name="enuVelEst" type="GeoSpatial.XYZVector" multiplicity="0..1" />
133 <elem name="enuVelErr" type="GeoSpatial.XYZVector" multiplicity="0..1" />
134 <elem name="stateTruth" type="HPE.StateVector" multiplicity="0..1" />
135 <elem name="stateEst" type="HPE.StateVector" multiplicity="0..1" />
136 <elem name="stateUncert" type="HPE.StateVector" multiplicity="0..1" />
137 <elem name="stateErr" type="HPE.StateVector" multiplicity="0..1" />
138 <elem name="miscdata" type="json" multiplicity="0..1" />
126 </struct> 139 </struct>
127 140
128 <!-- 141 <!--
...@@ -134,22 +147,24 @@ ...@@ -134,22 +147,24 @@
134 <comment>Calculated statistics for the associated the results.</comment> 147 <comment>Calculated statistics for the associated the results.</comment>
135 148
136 <elem name="count" type="uint32" multiplicity="1" /> 149 <elem name="count" type="uint32" multiplicity="1" />
150 <elem name="outliers" type="uint32" multiplicity="1" />
137 <elem name="cep50" type="float32" multiplicity="1" /> 151 <elem name="cep50" type="float32" multiplicity="1" />
138 <elem name="cep68" type="float32" multiplicity="1" /> 152 <elem name="cep68" type="float32" multiplicity="1" />
139 <elem name="cep95" type="float32" multiplicity="1" /> 153 <elem name="cep95" type="float32" multiplicity="1" />
140 <elem name="cepmax" type="float32" multiplicity="1" /> 154 <elem name="cepmax" type="float32" multiplicity="1" />
141 <elem name="rmsuncert" type="float32" multiplicity="1" /> 155 <elem name="rmsuncert" type="float32" multiplicity="1" />
142 <elem name="rmserr" type="float32" multiplicity="1" /> 156 <elem name="rmserr" type="float32" multiplicity="1" />
143 <elem name="meanState" type="HPE.StateVector" multiplicity="1" /> 157 <elem name="rmsEnuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
144 <elem name="meanStateErr" type="HPE.StateVector" multiplicity="1" /> 158 <elem name="rmsEnuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
145 <elem name="meanEnuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
146 <elem name="meanEnuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
147 <elem name="meanEnuVel" type="GeoSpatial.XYZVector" multiplicity="1" />
148 <elem name="meanEnuVelUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
149 <elem name="meanEnuVelErr" type="GeoSpatial.XYZVector" multiplicity="1" />
150 <elem name="meanFloor" type="float32" multiplicity="1" /> 159 <elem name="meanFloor" type="float32" multiplicity="1" />
151 <elem name="rmsFloorUncert" type="float32" multiplicity="1" /> 160 <elem name="rmsFloorUncert" type="float32" multiplicity="1" />
152 <elem name="rmsFloorErr" type="float32" multiplicity="1" /> 161 <elem name="rmsFloorErr" type="float32" multiplicity="1" />
162 <elem name="meanEnuVel" type="GeoSpatial.XYZVector" multiplicity="0..1" />
163 <elem name="rmsEnuVelUncert" type="GeoSpatial.XYZVector" multiplicity="0..1" />
164 <elem name="rmsEnuVelErr" type="GeoSpatial.XYZVector" multiplicity="0..1" />
165 <elem name="meanState" type="HPE.StateVector" multiplicity="0..1" />
166 <elem name="rmsStateErr" type="HPE.StateVector" multiplicity="0..1" />
167
153 </struct> 168 </struct>
154 169
155 <!-- 170 <!--
...@@ -160,16 +175,8 @@ ...@@ -160,16 +175,8 @@
160 <struct name="ServiceResults" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestResultSet"> 175 <struct name="ServiceResults" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestResultSet">
161 <comment>Specification for an ILP analysis test data result set.</comment> 176 <comment>Specification for an ILP analysis test data result set.</comment>
162 177
163 <elem name="records" type="ResultRecord" multiplicity="0..*">
164 <comment>The estimated position result records.</comment>
165 </elem>
166
167 <elem name="stats" type="Statistics" multiplicity="1">
168 <comment>Statistics for the result set.</comment>
169 </elem>
170
171 <elem name="confidence" type="float32" multiplicity="1" > 178 <elem name="confidence" type="float32" multiplicity="1" >
172 <comment>Confidence for the result records. Typically this will be .6872, but will report the confidence specified by the input.</comment> 179 <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>
173 </elem> 180 </elem>
174 181
175 <elem name="uriService" multiplicity = "1" type="Tensor.uri"> 182 <elem name="uriService" multiplicity = "1" type="Tensor.uri">
...@@ -177,7 +184,15 @@ ...@@ -177,7 +184,15 @@
177 Analysis can comprise multiple services processing the datasets and producing reports that provide a comparative performance. Check the API documentation for 184 Analysis can comprise multiple services processing the datasets and producing reports that provide a comparative performance. Check the API documentation for
178 querying a list of available service URIs (e.g. ILPS, etc.). 185 querying a list of available service URIs (e.g. ILPS, etc.).
179 </comment> 186 </comment>
180 </elem> 187 </elem>
188
189 <elem name="stats" type="Statistics" multiplicity="1">
190 <comment>Statistics for the result set.</comment>
191 </elem>
192
193 <elem name="records" type="ResultRecord" multiplicity="0..*">
194 <comment>The estimated position result records.</comment>
195 </elem>
181 196
182 </struct> 197 </struct>
183 198
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!