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

Configuration for checkerboard or stripe pattern stimulus writes. More...

#include <checkerboard.h>

Collaboration diagram for SimStimulusCheckerboardConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double period_x
 
double period_y
 
SimStimulusCoordConfig coord
 
double phase
 
double complex_phase
 
bool scale_by_dt
 

Detailed Description

Configuration for checkerboard or stripe pattern stimulus writes.

Member Data Documentation

◆ amplitude

double SimStimulusCheckerboardConfig::amplitude

Amplitude of the pattern.

◆ complex_phase

double SimStimulusCheckerboardConfig::complex_phase

Additional complex rotation for complex fields (radians).

◆ coord

SimStimulusCoordConfig SimStimulusCheckerboardConfig::coord

Spatial coordinate mapping configuration.

◆ field_index

size_t SimStimulusCheckerboardConfig::field_index

Target field index.

◆ period_x

double SimStimulusCheckerboardConfig::period_x

Period in coordinate units along X (>= 1).

◆ period_y

double SimStimulusCheckerboardConfig::period_y

Period in coordinate units along Y (> 0; <= 0 → stripes in X only).

◆ phase

double SimStimulusCheckerboardConfig::phase

Global phase offset in checker cells (0..1).

◆ scale_by_dt

bool SimStimulusCheckerboardConfig::scale_by_dt

When true, scale writes by dt; otherwise dt-independent.


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