Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 188 commits into from
Jun 6, 2023
Merged

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

merged 188 commits into from
Jun 6, 2023

Conversation

dboulware
Copy link
Contributor

This PR:

  • Adds a new diagnostics extension to provide diagnostic information on common sensing system components.
  • The algorithms extension has undergone a major change that migrates the old annotation based approach to using a list of data products. Currently, the only supported data product is a graph. Graphs provide a general way to describe data and should support a single data reader.
  • Calibration and signal analyzer settings are provided in captures.
  • Introduces a small ntia-nasctn-sea extension for metadata specific to the NASCTN SEA project.
  • Removes the Location extension in favor of using the SigMF Global geolocation element. As a result, the emitter extension was updated to use a geolocation GeoJSON Point element to specify the location of the emitter.
  • JSON Schema was manually created to update it to the current 2020-12 specification.
  • Java code was refactored to consolidate extensions into their own packages regardless of whether it is a global, annotation, or captures object.

dboulware and others added 30 commits April 7, 2023 15:01
@dboulware
WIP. Added diagnostics extension, update algorithm extension with dat…
8b662cf 
…aproducts, removed location extension, added nasctn-sea extension.
@dboulware
Corrected amplitude_bin_size and added amplitude_min/max. Java implem…
813005f 
…entation passing test from sensor.
@dboulware
Add missing files.
952f191
@dboulware
Diagnositcs spec corrections.
f0208ab
@dboulware
spec cleanup.
26c04b3
@dboulware
note ordering in dataproducts.
b26f42d
@dboulware
minor edits
e509cf1
@dboulware
make max of max channel power not required.
ead726e
@dboulware
Fixed length getter in AmplitudeProbabilityDistribution.
4563cb6
@dboulware
Add link to new nasctn-sea extension.
ffe51c5
@dboulware
nasctn-sea namespace cleanup.
34761f9
@dboulware
cleanup
79f2a03
@dboulware
Sigan settings and sensor example update.
ca8fb0b
@dboulware
SiganSettings cleanup
8f8ec37
@dboulware
schema update
12bbdc3
@dboulware
Removed CalibrationAnnotation and SensorAnnotation from Java implemen…
409528f 
…tation. Renamed Java class to SPU.
@dboulware
Cleanup diagnostics example.
f26b299
@dboulware
Update jar version.
fd70412
@dboulware
Update emitter geolocation description.
48a329a
@dboulware
Global getDataFilePath -> getFilePath in Java.
430d6fc
@dboulware
getFilePath -> getFilepath
0e2710f
@aromanielloNTIA
fix digitalfilter link
bb8046b
@aromanielloNTIA
markdownlint all documentation
0b87b01
@aromanielloNTIA
gnuradio/sigmf -> sigmf/SigMF in all links
b934bdd 
* Point to v1.x (current default) branch of SigMF. Changes made in v1.x should remain backwards-compatible with v1.0.0.
* Also includes a minor change to the datetime type listing for some objects, since the previously linked section can no longer be linked.
@aromanielloNTIA
consistent datetime type documentation
1f4734a
@dboulware
Fix dataproducts link in algorithms extension and setFilePath -> setF…
0b1e98c 
…ilepath.
@dboulware
Add back removed classes as deprecated.
0750366
@aromanielloNTIA
consistent doc titles
08531a2
@aromanielloNTIA
Always monospace extension names
be4f511
@aromanielloNTIA
consistent formatting, define datatypes section, add collection info
c467101
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-emitter.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-emitter.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia reviewed Jun 5, 2023
View reviewed changes
ntia-sensor.sigmf-ext.md Outdated Show resolved Hide resolved
jhazentia
jhazentia requested changes Jun 5, 2023
View reviewed changes
Copy link
Member

@jhazentia jhazentia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above comments

@dboulware
Update hardware spec and antenna links. Fix cpu_uptime type in spec. …
ad18c04 
…Correct xunits and yunits to x_units and y_units. Fix CPU type to Computer. Fix rfpaths link. Remove duplicate waveform extension listing. Remove setCoordinates in GeoJsonPoint. Update javadocs.
@dboulware dboulware requested a review from jhazentia June 5, 2023 19:14
aromanielloNTIA
aromanielloNTIA approved these changes Jun 5, 2023
View reviewed changes
java/src/main/java/gov/doc/ntia/sigmf/Acquisition.java
* Get the action that produced the Acquisition, or unknown if it is not in the metadata.
* @return The name of the action that produced the Acquisition.
*/
public String getActionName() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please confirm that removal of getActionName is intended

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was, but I think it makes sense to add back in.

java/src/main/java/gov/doc/ntia/sigmf/Global.java Show resolved Hide resolved
java/src/main/java/gov/doc/ntia/sigmf/SchemaGenerator.java
@@ -1,34 +0,0 @@
package gov.doc.ntia.sigmf;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was SchemaGenerator removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It didn't handle some annotations properly and wasn't generating the schema in the latest version of the JSON Schema spec (2020-12)

@dboulware dboulware merged commit 431ea80 into master Jun 6, 2023
@dboulware dboulware deleted the diagnostics_dataproducts_graphs branch June 6, 2023 15:17
@aromanielloNTIA aromanielloNTIA mentioned this pull request Jun 7, 2023
Closed
This was referenced Jun 14, 2023
Merged
Merged
@aromanielloNTIA aromanielloNTIA mentioned this pull request Aug 4, 2023
Merged
@aromanielloNTIA aromanielloNTIA mentioned this pull request Oct 18, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhazentia jhazentia jhazentia approved these changes

@aromanielloNTIA aromanielloNTIA aromanielloNTIA approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@dboulware @aromanielloNTIA @jhazentia