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

Configuration parameters for the coordinate generator operator. More...

#include <coordinate.h>

Collaboration diagram for SimCoordinateOperatorConfig:

Public Attributes

size_t output_field
 
SimCoordinateMode mode
 
SimCoordinateNormalizeMode normalize
 
SimStimulusCoordConfig coord
 
double gain
 
double bias
 
double time_offset
 
bool accumulate
 
bool scale_by_dt
 
bool exact_gain_enabled
 
uint64_t exact_gain_raw
 
bool exact_bias_enabled
 
uint64_t exact_bias_raw
 

Detailed Description

Configuration parameters for the coordinate generator operator.

Member Data Documentation

◆ accumulate

bool SimCoordinateOperatorConfig::accumulate

Add into output when true.

◆ bias

double SimCoordinateOperatorConfig::bias

Bias added after gain.

◆ coord

SimStimulusCoordConfig SimCoordinateOperatorConfig::coord

Coordinate mapping configuration.

◆ exact_bias_enabled

bool SimCoordinateOperatorConfig::exact_bias_enabled

Interpret exact_bias_raw in the output integer domain.

◆ exact_bias_raw

uint64_t SimCoordinateOperatorConfig::exact_bias_raw

Exact bias literal encoded in the output integer domain.

◆ exact_gain_enabled

bool SimCoordinateOperatorConfig::exact_gain_enabled

Interpret exact_gain_raw in the output integer domain.

◆ exact_gain_raw

uint64_t SimCoordinateOperatorConfig::exact_gain_raw

Exact gain literal encoded in the output integer domain.

◆ gain

double SimCoordinateOperatorConfig::gain

Gain applied after normalization.

◆ mode

SimCoordinateMode SimCoordinateOperatorConfig::mode

Index vs coordinate mapping.

◆ normalize

SimCoordinateNormalizeMode SimCoordinateOperatorConfig::normalize

Optional normalization mode.

◆ output_field

size_t SimCoordinateOperatorConfig::output_field

Field receiving the coordinate values.

◆ scale_by_dt

bool SimCoordinateOperatorConfig::scale_by_dt

Scale accumulated writes by substep dt.

◆ time_offset

double SimCoordinateOperatorConfig::time_offset

Time offset (used by radial velocity).


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