Merge branch 'ILP-1118' into 'master'

ILP-1118 - Added Filtering and Updated documentation See merge request !7

Merge branch 'ILP-1118' into 'master'
ILP-1118 - Added Filtering and Updated documentation See merge request !7
Pavan Sabbineni
Showing 2 changed files with 68 additions and 38 deletions
GeoSpatial/V1.0/SpatialDefs.xid.xml
ILP/V1.2/IlpAnalysisApi.xid.xml
--- a/GeoSpatial/V1.0/SpatialDefs.xid.xml
View file @9adf911
+++ b/GeoSpatial/V1.0/SpatialDefs.xid.xml
View file @9adf911
@@ -51,31 +51,33 @@
    <struct name="BoundingBox" pack="true">
      <comment>Defines a bounding box in WGS84 reference frame.</comment>
-      <comment>Units for latitude and longitude are in units of micro degrees (1e-6 degrees) providing for about 11 cm resolution near the equator.</comment>
+      <comment>
+          Units for latitude and longitude are in units of micro degrees (1e-6 degrees) providing for about 11 cm resolution near the equator. Altitude units are in millimeters.
+      </comment>
      <elem name="latmin" type="Tensor.int32" multiplicity="1" >
-        <comment>Minimum value of the latitude.</comment>
+        <comment>Minimum value of the latitude. Valid range is -90,000,000 <= lat <= 90,000,000. </comment>
        <tag name="unit" value="microdegrees"/>
      </elem>
      <elem name="latmax" type="Tensor.int32" multiplicity="1" >
-        <comment>Maximum value of the latitude.</comment>
+        <comment>Maximum value of the latitude. Valid range is -90,000,000 <= lat <= 90,000,000.</comment>
        <tag name="unit" value="microdegrees"/>
      </elem>
      <elem name="lonmin" type="Tensor.int32" multiplicity="1" >
-        <comment>Minimum value of the longitude.</comment>
+        <comment>Minimum value of the longitude. Valid range is -180,000,000 <= lat <= 180,000,000.</comment>
        <tag name="unit" value="microdegrees"/>
      </elem>
      <elem name="lonmax" type="Tensor.int32" multiplicity="1" >
-        <comment>Maximum value of the longitude.</comment>
+        <comment>Maximum value of the longitude. Valid range is -180,000,000 <= lat <= 180,000,000.</comment>
        <tag name="unit" value="microdegrees"/>
      </elem>
      <elem name="altmin" type="Tensor.int32" multiplicity="1" >
-        <comment>Minimum value of the altitude.</comment>
+        <comment>Minimum value of the altitude.  Valid range is +- 1,000,000,000 cm.</comment>
-        <tag name="unit" value="microdegrees"/>
+        <tag name="unit" value="cm"/>
      </elem>
      <elem name="altmax" type="Tensor.int32" multiplicity="1" >
-        <comment>Maximum value of the altitude.</comment>
+        <comment>Maximum value of the altitude. Valid range is +- 1,000,000,000 cm.</comment>
-        <tag name="unit" value="microdegrees"/>
+        <tag name="unit" value="cm"/>
      </elem>
    </struct>
--- a/ILP/V1.2/IlpAnalysisApi.xid.xml
View file @9adf911
+++ b/ILP/V1.2/IlpAnalysisApi.xid.xml
View file @9adf911
@@ -40,9 +40,6 @@
      <elem name="bounds" multiplicity ="0..1" type="GeoSpatial.BoundingBox" >
        <comment>Optional bounding box, which the records are contained.</comment>
      </elem>
-      <elem name="devids" multiplicity ="0..*" type="string" >
-        <comment>Optional set of device idenifers to select for execution.</comment>
-      </elem>
    </struct>
@@ -53,6 +50,12 @@
    -->
    <struct name="DataSet" type="GeoSpatial.Object" rttkey="GeoSpatial.ObjectType.IlpTestDataSet">
      <comment>DataSet comprises one or more surveys to use as analysis test records.</comment>
+      <elem name="filter" multiplicity ="0..1" type="Filter" >
+        <comment>
+        Optional filter specifies which test data records and observations should be used for testing.  If not
+        specified, all test data will be used.
+        </comment>
+      </elem>
      <elem name="uuidData" multiplicity ="0..*" type="UUID" >
        <comment>Zero or more UUIDs identifying the survey test data to include in this data set.</comment>
      </elem>
@@ -77,7 +80,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 +88,24 @@
      <elem name="modifiedDate" type="datetime" multiplicity="1">
        <comment>Date and time the test specification was modified.</comment>
      </elem>
+      <elem name="extendedResults" multiplicity="0..1" type="bool">
+          <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.  If not specified, it is assumed false, providing only standard results.
+          </comment> 
+      </elem>
+      <elem name="cutoff" multiplicity="0..1" type="int32" >
+        <comment>
+            Specifies the cutoff in number of standard deviations from the mean error.  The default 
+            is 1000, which means any results more than 1000 standard deviations from the mean are
+            are outliers and not considered in calculation of the summary statistics. This will include 
+            all data in most well formed cases.  Values of 5 are typical when using cutoff.
+            to include even the worst data.
+        </comment>
+      </elem>
      <elem name="contact" multiplicity ="0..1" type="GeoSpatial.ContactInfo" >
        <comment>Optional contact information.</comment>
@@ -93,6 +114,8 @@
      <elem name="datasets" multiplicity="0..*" type="DataSet">
        <comment>Dataset specifications to process.</comment>
      </elem>
    </struct>
    <!-- 
@@ -101,27 +124,30 @@
    *************************************
    -->
    <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="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 +160,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="rmsEnuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
-      <elem name="meanStateErr" type="HPE.StateVector" multiplicity="1" />
+      <elem name="rmsEnuUncert" type="GeoSpatial.XYZVector" 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="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 +188,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 +197,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>