Add diagnostics and data products. Specify sigan settings and cal info captures. JSON Schema 2020-12.

.gitignore/.gitignore → .gitignore

@@ -209,3 +209,8 @@ fabric.properties
 /dist/
 /nbdist/
 /.nb-gradle/
+
+# gradle/intellij from java folder
+java/.gradle
+java/.idea
+java/bin

Matlab/README.md

@@ -1,88 +1,91 @@
 # SigMF-NS-NTIA in Matlab
 
-Working with the SigMF-NS-NTIA SigMF extensions in Matlab can be made much easier by using the Java libraries within this repository.  The guide below provides useful tips to interact with the Java implementation of the SigMF-NS-NTIA extension within Matlab. 
-## Tips for using the  SigMF-NS-NTIA Java implementation with Matlab. 
+Working with the SigMF-NS-NTIA SigMF extensions in Matlab can be made much easier by using the Java libraries within this repository.  The guide below provides useful tips to interact with the Java implementation of the SigMF-NS-NTIA extension within Matlab.
+
+## Tips for using the  SigMF-NS-NTIA Java implementation with Matlab
+
+The jar file is available for download in the GitHub [packages page](https://github.com/orgs/NTIA/packages?repo_name=sigmf-ns-ntia) of this repository.
 
 ### 1.  Add the SigMF-NS_NTIA Jar file to Matlab
 
-There are several alternative ways to add the jar file to Matlab. 
+There are several alternative ways to add the jar file to Matlab.
 
-#### 1.1 Adding the jar file temporarily 
+#### 1.1 Adding the jar file temporarily
 
-Adding the jar file to the dynamic path allows you to add the jar file to only you current session of Matlab. To add the jar file only to the current session, execute the following command in Matlab after replacing the path to the jar file with the path to the jar file on your computer. 
+Adding the jar file to the dynamic path allows you to add the jar file to only your current session of Matlab. To add the jar file only to the current session, execute the following command in Matlab after replacing the path to the jar file with the path to the jar file on your computer.
 
-`javaclasspath({'C:\Users\dboulware\Documents\sigmf-ns-ntia\sigmf-ns-ntia\java\build\libs\sigmf-ns-ntia-0.0.4-SNAPSHOT.jar'});`
+```matlab
+javaclasspath({'C:\path\to\sigmf-ns-ntia-2.0.0.jar'});
+```
 
+#### 1.2 Adding the jar to the static path
 
-#### 1.1 Adding the jar to the static path
-Adding the jar file to Matlab's static path will allow the library to be used at anytime in Matlab. Add the jar to the Matlab's static path by: <br/>
+Adding the jar file to Matlab's static path will allow the library to be used at anytime in Matlab. Add the jar to the Matlab's static path by:
 
 1. Execute the `prefdir` command in Matlab to identify your preferences directory.
 2. Close Matlab.
 3. Go to your preferences directory identified by the above command and create an ASCII text file named `javaclasspath.txt`.
 4. Add the full path to the `sigmf-ns-ntia` jar to the `javaclasspath.txt` file
 5. Now you should be able to start and use the simf-ns-ntia java library from within Matlab as detailed below.
 
-### Using the Java library from within Matlab
-
-This section provides examples of the common ways to interact with the `sigmf-ns-ntia` java library within Matlab. 
-
-#### Java library Overview
-
-The `sigmf-ns-ntia` java library consists of a number classes that define an object oriented approach to modeling the `sigmf-ns-ntia` extensions to SigMF. As such, to get and set values  within the SigMF you will primarily be creating instances of the different objects defined within the library and calling various get and set methods on those objects to get and set the various values. In Java, classes can be organized into a set of packages and the `sigmf-ns-ntia` library is organized in packages that mimic the extensions defined in [sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia).  The base package in the java library is `gov.doc.ntia.sigmf` so all objects you utilize will begin with `gov.doc.ntia.sigmf`. The `gov.doc.ntia.sigmf.ext.global` package includes subpackages to organize the global objects defined in  [sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia) and `gov.doc.ntia.sigmf.ext.annotation` package includes subpackages to organize the annoation extensions defined in [sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia).  The table below shows the mapping between Java packages and the extensions defined in  [sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia) 
-
-|Package|Extension|Description|
-|----|--------|-----------|
-|`gov.doc.ntia.sigmf`|NA|Contains the objects that are part of the core [SigMF](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md), including: `MetaDoc`, `Global`, and `Annotation`.|
-|`gov.doc.ntia.sigmf.ext.global.algorithm`|[ntia-algorithm](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-algorithm.sigmf-ext.md)|Contains objects to represent the global objects defined in [ntia-algorithm](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-algorithm.sigmf-ext.md) including `DigitalFilter`|
-|`gov.doc.ntia.sigmf.ext.global.core`|[ntia-core](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-core.sigmf-ext.md)|Contains objects to represent global objects defined in [ntia-core](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-core.sigmf-ext.md) including `Measurement`, `Antenna`, and `HardwareSpec`|
-|`gov.doc.ntia.sigmf.ext.global.emitter`|[ntia-emitter](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-emitter.sigmf-ext.md)|Contains objects to represent the global objects defined in [ntia-emitter](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-emitter.sigmf-ext.md) including `Emitter`.|
-|`gov.doc.ntia.sigmf.ext.global.environment`|[ntia-environment](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-environment.sigmf-ext.md)|Contains objects to represent the global objects defined in [ntia-environment](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-environment.sigmf-ext.md) including `Environment`|
-|`gov.doc.ntia.sigmf.ext.global.location`|[ntia-location](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-location.sigmf-ext.md)|Contains objects to represent the global objects defined in [ntia-location](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-location.sigmf-ext.md) including `GeographicCoordinateSystem`, `ProjectedCoordinateSystem`, `Datum`, `Spheroid`, and `Location`|
-|`gov.doc.ntia.sigmf.ext.global.sensor`|[ntia-sensor](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-sensor.sigmf-ext.md)|Contains objects to represent the global objects defined in [ntia-sensor](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-sensor.sigmf-ext.md) including `Sensor`, `Preselector`, `SignalAnalyzer`, `Amplifier`, `Filter`, `CalSource` and `RFPath`|
-|`gov.doc.ntia.sigmf.ext.global.waveform`|[ntia-waveform](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-waveform.sigmf-ext.md)|Contains objects to represent the global objects defined in [ntia-waveform](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-waveform.sigmf-ext.md) including `Waveform` and `IEEE80211p`|
-|`gov.doc.ntia.sigmf.ext.annotation.algorithm`|[ntia-algorithm](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-algorithm.sigmf-ext.md)|Contains objects to represent the annotation objects defined in [ntia-algorithm](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-algorithm.sigmf-ext.md) including `TimeDomainDetection`, `FrequencyDomainDetection`, and `DigitalFilterAnnotation`|
-|`gov.doc.ntia.sigmf.ext.annotation.sensor`|[ntia-sensor](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-sensor.sigmf-ext.md)|Contains objects to represent the annotation objects defined in [ntia-sensor](https://github.com/NTIA/sigmf-ns-ntia/blob/master/ntia-sensor.sigmf-ext.md) including `SensorAnnotation` and `CalibrationAnnotation`|
-
-
-#### Using the Java library
+### 2. Using the Java library from within Matlab
+
+This section provides examples of the common ways to interact with the `sigmf-ns-ntia` java library within Matlab.
+
+#### 2.1 Java library Overview
+
+The `sigmf-ns-ntia` Java library consists of a number classes that define an object oriented approach to modeling the `sigmf-ns-ntia`
+extensions to SigMF. As such, to get and set values  within the SigMF you will primarily be creating instances of the 
+different objects defined within the library and calling various get and set methods on those objects to get and set
+the various values. In Java, classes can be organized into a set of packages and the `sigmf-ns-ntia` library is
+organized in packages that mimic the extensions defined in [sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia).  The
+base package in the Java library is `gov.doc.ntia.sigmf` so all objects you utilize will begin with `gov.doc.ntia.sigmf`. 
+The `gov.doc.ntia.sigmf.ext` package includes subpackages for each extension in 
+[sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia).  The table below shows the mapping between Java packages and 
+the extensions defined in [sigmf-ns-ntia](https://github.com/NTIA/sigmf-ns-ntia). Extensions to the global object are 
+provided directly in the `gov.doc.ntia.sigmf.Global` class. 
+
+| Package                                  |Extension|
+|------------------------------------------|--------|
+| `gov.doc.ntia.sigmf`                     |Base [SigMF](https://github.com/sigmf/SigMF/blob/sigmf-v1.x/sigmf-spec.md)|
+| `gov.doc.ntia.sigmf.ext.algorithm`       |[`ntia-algorithm`](../ntia-algorithm.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.core`     |[`ntia-core`](../ntia-core.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.diagnostics` |[`ntia-diagnostics`](../ntia-diagnostics.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.emitter`  |[`ntia-emitter`](../ntia-emitter.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.environment` |[`ntia-environment`](../ntia-environment.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.scos`     |[`ntia-scos`](../ntia-scos.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.sensor`   |[`ntia-sensor`](../ntia-sensor.sigmf-ext.md)|
+| `gov.doc.ntia.sigmf.ext.waveform` |[`ntia-waveform`](../ntia-waveform.sigmf-ext.md)|
+
+#### 2.2 Using the Java library
 
 Utilizing the Java library from within Matlab mostly requires you to create instances of the objects and use the set and get methods on those objects to set or get the value of interest.  Creating an instance of a Java object is as simple as calling the constructor with the full name (including the package) of the class as shown in the example below. Note: as shown below, certain types like long and double require you specify them as their java type.
 
-```
+```matlab
   metaDoc = gov.doc.ntia.sigmf.MetaDoc();
   globalExample = gov.doc.ntia.sigmf.Global();
-  sensor = gov.doc.ntia.sigmf.ext.global.sensor.Sensor(); 
-  antenna = gov.doc.ntia.sigmf.ext.global.core.Antenna(); 
+  sensor = gov.doc.ntia.sigmf.ext.sensor.Sensor(); 
+  antenna = gov.doc.ntia.sigmf.ext.core.Antenna(); 
 
   setType(antenna, "dipole"); 
   setGain(antenna, java.lang.Double(7)); 
-  hardwareSpec = gov.doc.ntia.sigmf.ext.global.core.HardwareSpec();
+  hardwareSpec = gov.doc.ntia.sigmf.ext.core.HardwareSpec();
   setModel(hardwareSpec, "ARA CSB-16");
   setId(hardwareSpec, "antenna_1");
   setAntennaSpec(antenna, hardwareSpec);
 
   setId(sensor, "greyhound-1");
   setAntenna(sensor, antenna);
 
-  detection = gov.doc.ntia.sigmf.ext.annotation.algorithm.FrequencyDomainDetection();
-  setDetector(detection, "fft_mean_power");
-  setNumberOfFfts(detection, 1024);
-  setNumberOfSamplesInFft(detection, 1024);
-  setWindow(detection, "blackman-harris");
-  setSampleStart(detection, java.lang.Long(0));
-  setSampleCount(detection, java.lang.Long(1024));
-
   setSensor(globalExample, sensor);
   setGlobal(metaDoc, globalExample);
 
-  saveToFile(metaDoc, "C:\Users\dboulware\Documents\sigmf-ns-ntia\example.json");
-
-
+  saveToFile(metaDoc, "C:\path\to\example.json");
 ```
 
 Now, if we open the file we will see the following:
-```
+
+```json
 {
   "global": {
     "ntia-sensor:sensor": {
@@ -97,37 +100,14 @@ Now, if we open the file we will see the following:
       }
     }
   },
-  "captures": [
-
-  ],
-  "annotations": [
-    {
-      "ntia-core:annotation_type": "FrequencyDomainDetection",
-      "core:sample_start": 0,
-      "core:sample_count": 1024,
-      "ntia-algorithm:detector": "fft_mean_power",
-      "ntia-algorithm:number_of_ffts": 1024,
-      "ntia-algorithm:number_of_samples_in_fft": 1024,
-      "ntia-algorithm:window": "blackman-harris"
-    }
-  ]
+  "captures": [],
+  "annotations": []
 }
 
 ```
-Finally, if we simply wanted to read the example.json in Matlab we would use the static read method provided by the SigMfReader class. Because it is a static method you must call it slightly differently, as shown below:
-
-
-`readMetaDoc = javaMethod('read', 'gov.doc.ntia.sigmf.SigMfReader',' 'C:\Users\dboulware\Documents\sigmf-ns-ntia\example.json');`
-
-
-
-
-
-
-
-
-
-
-
 
+Finally, if we simply wanted to read the `example.json` in Matlab we would use the static read method provided by the `SigMfReader` class. Because it is a static method you must call it slightly differently, as shown below:
 
+```matlab
+readMetaDoc = javaMethod('read', 'gov.doc.ntia.sigmf.SigMfReader', 'C:\path\to\example.json');
+```

README.md

@@ -1,20 +1,20 @@
 # SigMF-NS-NTIA
 
-This Signal Metadata Format [SigMF](https://github.com/gnuradio/SigMF) namespace extension describes the National
+This Signal Metadata Format [SigMF](https://github.com/sigmf/SigMF) namespace extension describes the National
 Telecommunications and Information Administration (NTIA)'s open data format for
 recorded signal datasets.
 
 ## Introduction
 
 SigMF is a simple, extensible standard for
 storing recorded signal datasets. The
-[Introduction](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#introduction)
+[Introduction](https://github.com/sigmf/SigMF/blob/sigmf-v1.x/sigmf-spec.md#introduction)
 to the core specification document explains why such a standard is useful:
 
 > Sharing sets of recorded signal data is an important part of science and engineering. It enables multiple parties to collaborate, is often a necessary part of reproducing scientific results (a requirement of scientific rigor), and enables sharing data with those who do not have direct access to the equipment required to capture it.
-
+>
 > Unfortunately, these datasets have historically not been very portable, and there is not an agreed upon method of sharing metadata descriptions of the recorded data itself. This is the problem that SigMF solves.
-
+>
 > By providing a standard way to describe data recordings, SigMF facilitates the sharing of data, prevents the "bitrot" of datasets wherein details of the capture are lost over time, and makes it possible for different tools to operate on the same dataset, thus enabling data portability between tools and workflows.
 
 At NTIA, we have traditionally used several proprietary or internally-designed
@@ -25,10 +25,10 @@ extensions to the core SigMF specification.
 
 - [`ntia-algorithm`](ntia-algorithm.sigmf-ext.md) describes the measurement performed (detectors, algorithms, etc)
 - [`ntia-core`](ntia-core.sigmf-ext.md) adds generally useful metadata fields
+- [`ntia-diagnostics`](ntia-diagnostics.sigmf-ext.md) provides metadata to describe system diagnostic information.
 - [`ntia-emitter`](ntia-emitter.sigmf-ext.md) gives information about the emitter being measured
 - [`ntia-environment`](ntia-environment.sigmf-ext.md) gives information about the environment around a sensor or emitter
-- [`ntia-location`](ntia-location.sigmf-ext.md) gives information about the types of coordinate systems used in the metadata.
-- [`ntia-scos`](ntia-scos.sigmf-ext.md) provides metadata for the NTIA Spectrum Characterization and Occupancy Sensing (SCOS) implementation 
+- [`ntia-nasctn-sea`](ntia-nasctn-sea.sigmf-ext.md) provides metadata used within NASCTN Sharing Ecosystem Assessment project.  
+- [`ntia-scos`](ntia-scos.sigmf-ext.md) provides metadata for the NTIA Spectrum Characterization and Occupancy Sensing (SCOS) implementation
 - [`ntia-sensor`](ntia-sensor.sigmf-ext.md) defines hardware components and settings
 - [`ntia-waveform`](ntia-waveform.sigmf-ext.md) provides metadata to describe measured or transmitted waveforms
-

java/build.gradle

@@ -14,7 +14,7 @@ def versions = [
 def archiveBaseName= 'sigmf-ns-ntia'
 
 group = 'gov.doc.ntia'
-version = '1.0.1'
+version = '2.0.0'
 
 sourceCompatibility = 1.8
 
@@ -28,11 +28,10 @@ configurations {
 }
 
 dependencies {
-    implementation 'com.fasterxml.jackson.core:jackson-annotations:2.9.8'
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.9.8'
-    implementation 'com.fasterxml.jackson.module:jackson-module-jsonSchema:2.9.0'
-    implementation 'com.kjetland:mbknor-jackson-jsonschema_2.12:1.0.36'
+    implementation 'com.fasterxml.jackson.core:jackson-annotations:2.15.0'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.15.0'
     implementation 'org.springframework.data:spring-data-commons-core:1.4.1.RELEASE'
+    implementation 'org.springframework.boot:spring-boot-starter-validation:2.7.0'
     implementation 'commons-io:commons-io:2.5'
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.3.1'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.3.1'