sieve.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_SIEVE_H
#define OAKFIELD_SIEVE_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimSieveMode {
    SIM_SIEVE_MODE_LOW_PASS = 0,       
    SIM_SIEVE_MODE_HIGH_PASS,          
    SIM_SIEVE_MODE_BAND_PASS_DOG,      
    SIM_SIEVE_MODE_BAND_STOP_DOG,      
    SIM_SIEVE_MODE_SAVGOL_SMOOTH,      
    SIM_SIEVE_MODE_SAVGOL_DERIVATIVE,  
    SIM_SIEVE_MODE_HANN_LOW_PASS,      
    SIM_SIEVE_MODE_HANN_HIGH_PASS,     
    SIM_SIEVE_MODE_BLACKMAN_LOW_PASS,  
    SIM_SIEVE_MODE_BLACKMAN_HIGH_PASS, 
    SIM_SIEVE_MODE_TUKEY_LOW_PASS,     
    SIM_SIEVE_MODE_TUKEY_HIGH_PASS     
} SimSieveMode;
 
typedef struct SimSieveOperatorConfig {
    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;              
} SimSieveOperatorConfig;
 
SimResult sim_add_sieve_operator(struct SimContext *context, const SimSieveOperatorConfig *config,
                                 size_t *out_index);
 
SimResult sim_sieve_config(struct SimContext *context, size_t operator_index,
                           SimSieveOperatorConfig *out_config);
 
SimResult sim_sieve_update(struct SimContext *context, size_t operator_index,
                           const SimSieveOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_SIEVE_H */