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

Configuration parameters for the sieve operator family. More...

#include <sieve.h>

Public Attributes

size_t input_field
 
size_t output_field
 
unsigned int taps
 
double sigma
 
double sigma2
 
unsigned int poly_order
 
unsigned int derivative_order
 
double sample_spacing
 
double window_alpha
 
double gain
 
SimSieveMode mode
 
SimIRBoundaryPolicy boundary
 
bool accumulate
 
bool scale_by_dt
 

Detailed Description

Configuration parameters for the sieve operator family.

Member Data Documentation

◆ accumulate

bool SimSieveOperatorConfig::accumulate

Add into output when true.

◆ boundary

SimIRBoundaryPolicy SimSieveOperatorConfig::boundary

Boundary handling policy for out-of-range samples.

◆ derivative_order

unsigned int SimSieveOperatorConfig::derivative_order

Derivative order for Savitzky-Golay derivative mode.

◆ gain

double SimSieveOperatorConfig::gain

Output gain applied after filtering.

◆ input_field

size_t SimSieveOperatorConfig::input_field

Field to be filtered.

◆ mode

SimSieveMode SimSieveOperatorConfig::mode

Selected sieve response family.

◆ output_field

size_t SimSieveOperatorConfig::output_field

Field receiving the filtered result.

◆ poly_order

unsigned int SimSieveOperatorConfig::poly_order

Polynomial order for Savitzky-Golay modes.

◆ sample_spacing

double SimSieveOperatorConfig::sample_spacing

Sample spacing used to scale derivatives.

◆ scale_by_dt

bool SimSieveOperatorConfig::scale_by_dt

When true, scale accumulated writes by substep dt.

◆ sigma

double SimSieveOperatorConfig::sigma

Primary Gaussian/window scale.

◆ sigma2

double SimSieveOperatorConfig::sigma2

Secondary scale used by band-pass/stop (DoG).

◆ taps

unsigned int SimSieveOperatorConfig::taps

Kernel length (odd, >=3).

◆ window_alpha

double SimSieveOperatorConfig::window_alpha

Tukey alpha override; <=0 derives from sigma.


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