Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimFieldStats Struct Reference

Summary statistics for a scalar or complex field slice. More...

#include <sim_field_stats.h>

Public Attributes

double mean_re
 
double mean_im
 
double mean
 
double mean_abs
 
double rms
 
double var_re
 
double var_im
 
double var_abs
 
double max_abs
 
double phase_coherence
 
double circularity
 
double spectral_entropy
 
double spectral_bandwidth
 
double phase_coherence_weighted
 
double phase_coherence_ema
 
double phase_coherence_k0
 
size_t phase_sample_count
 
uint8_t phase_lock_state
 
uint8_t phase_regime
 
uint8_t topology_valid
 
size_t count
 
size_t topology_positive_singularities
 
size_t topology_negative_singularities
 
size_t topology_seam_edge_count
 
size_t topology_ambiguous_cell_count
 
uint64_t continuity_dirty_ops
 
uint64_t continuity_stable_ops
 

Detailed Description

Summary statistics for a scalar or complex field slice.

Member Data Documentation

◆ circularity

double SimFieldStats::circularity

Circularity metric for the complex sample cloud.

◆ continuity_dirty_ops

uint64_t SimFieldStats::continuity_dirty_ops

Operators that wrote without continuity guards (per step).

◆ continuity_stable_ops

uint64_t SimFieldStats::continuity_stable_ops

Operators that wrote with clamped/limited continuity.

◆ count

size_t SimFieldStats::count

Number of field samples included.

◆ max_abs

double SimFieldStats::max_abs

Maximum magnitude.

◆ mean

double SimFieldStats::mean

Legacy alias for mean_re.

◆ mean_abs

double SimFieldStats::mean_abs

Mean magnitude.

◆ mean_im

double SimFieldStats::mean_im

Mean imaginary component.

◆ mean_re

double SimFieldStats::mean_re

Mean real component.

◆ phase_coherence

double SimFieldStats::phase_coherence

Unweighted phase coherence in [0, 1].

◆ phase_coherence_ema

double SimFieldStats::phase_coherence_ema

Exponential moving average of phase coherence.

◆ phase_coherence_k0

double SimFieldStats::phase_coherence_k0

Phase coherence after dominant-bin deramping.

◆ phase_coherence_weighted

double SimFieldStats::phase_coherence_weighted

Magnitude-weighted phase coherence.

◆ phase_lock_state

uint8_t SimFieldStats::phase_lock_state

Hysteresis lock state derived from coherence.

◆ phase_regime

uint8_t SimFieldStats::phase_regime

Coarse phase-regime classification.

◆ phase_sample_count

size_t SimFieldStats::phase_sample_count

Number of samples used for phase metrics.

◆ rms

double SimFieldStats::rms

Root-mean-square magnitude.

◆ spectral_bandwidth

double SimFieldStats::spectral_bandwidth

Spectral bandwidth estimate.

◆ spectral_entropy

double SimFieldStats::spectral_entropy

Normalized spectral entropy.

◆ topology_ambiguous_cell_count

size_t SimFieldStats::topology_ambiguous_cell_count

Count of ambiguous topology cells.

◆ topology_negative_singularities

size_t SimFieldStats::topology_negative_singularities

Count of negative phase singularities.

◆ topology_positive_singularities

size_t SimFieldStats::topology_positive_singularities

Count of positive phase singularities.

◆ topology_seam_edge_count

size_t SimFieldStats::topology_seam_edge_count

Count of detected topology seam edges.

◆ topology_valid

uint8_t SimFieldStats::topology_valid

True when topology fields contain valid counts.

◆ var_abs

double SimFieldStats::var_abs

Variance of magnitudes.

◆ var_im

double SimFieldStats::var_im

Variance of the imaginary component.

◆ var_re

double SimFieldStats::var_re

Variance of the real component.


The documentation for this struct was generated from the following file: