Struct Annotation 

pub struct Annotation {
    pub sample_start: usize,
    pub sample_count: Option<usize>,
    pub label: Option<String>,
    pub comment: Option<String>,
    pub freq_lower_edge: Option<f64>,
    pub freq_upper_edge: Option<f64>,
}

An annotation of a SigMF recording.

Fields

sample_start: usize

core:sample_start.

sample_count: Option<usize>

core:sample_count (to the end of the recording when absent).

label: Option<String>

core:label (a short name: the modulation, the emitter, …).

comment: Option<String>

core:comment.

freq_lower_edge: Option<f64>

core:freq_lower_edge (Hz).

freq_upper_edge: Option<f64>

core:freq_upper_edge (Hz).

Implementations

impl Annotation

pub const KEYS: [&'static str; 6]

The keys of Annotation::from_mapping.

pub fn from_mapping(a: &Json) -> Result<Annotation>

An annotation from a mapping of the keys of Annotation::KEYS (the SigMF keys without their core: prefix), as the Python bindings take it: sample_start is required, the others are optional.

Errors

Error::Config for another key, or a missing or negative sample_start.

Examples

use comnum_spec::io::Annotation;
let a = Annotation::from_mapping(&serde_json::json!({"sample_start": 3, "label": "QPSK"}))?;
assert_eq!((a.sample_start, a.label.as_deref()), (3, Some("QPSK")));
assert!(Annotation::from_mapping(&serde_json::json!({"sample_start": 3, "start": 1})).is_err());

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Annotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Annotation

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Annotation

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Annotation