Skip to content

Commit

Permalink
Docs: Empty captures array implies start sample of 0 (#327)
Browse files Browse the repository at this point in the history
* Empty captures array implies start sample of 0

* Clarify `captures` object description in schema
  • Loading branch information
777arc authored Dec 17, 2024
1 parent 0124669 commit dfd1584
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion sigmf-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@
"additionalProperties": true
},
"captures": {
"description": "The `captures` Object is an array of capture segment objects that describe the parameters of the signal capture. It MUST be sorted by the value of each capture segment's `core:sample_start` key, ascending. Capture Segment Objects are composed of key/value pairs, and each Segment describes a chunk of samples that can be mapped into memory for processing. Each Segment MUST contain a `core:sample_start` key/value pair, which indicates the sample index relative to the Dataset where this Segment's metadata applies. The fields that are described within a Capture Segment are scoped to that Segment only and need to be explicitly declared again if they are valid in subsequent Segments. ",
"description": "The `captures` Object is an array of capture segment objects that describe the parameters of the signal capture. It MUST be sorted by the value of each capture segment's `core:sample_start` key, ascending. Capture Segment Objects are composed of key/value pairs, and each Segment describes a chunk of samples that can be mapped into memory for processing. Each Segment MUST contain a `core:sample_start` key/value pair, which indicates the sample index relative to the Dataset where this Segment's metadata applies. The fields that are described within a Capture Segment are scoped to that Segment only and need to be explicitly declared again if they are valid in subsequent Segments. While it is recommended there be at least one segment defined, if there are no items in the captures array it is implied that a single capture exists with `core:sample_start` equal to zero (no other metadata is implied), i.e., `\"captures\": []` implies `\"captures\": [{\"core:sample_start\": 0}]`.",
"default": [],
"type": "array",
"additionalItems": false,
Expand Down

0 comments on commit dfd1584

Please sign in to comment.