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

Shared configuration for digamma square stimulus variants. More...

#include <digamma_square.h>

Collaboration diagram for SimStimulusDigammaSquareConfig:

Public Attributes

size_t field_index
 
size_t warp_field_index
 
double amplitude
 
double wavenumber
 
double kx
 
double ky
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
double nominal_dt
 
double velocity
 
double harmonics
 
double a
 
double rotation
 
double tolerance
 
bool fixed_clock
 
bool scale_by_dt
 
bool use_wavevector
 
bool use_warp
 
double warp_mix
 
double warp_bias
 
SimMixerMode warp_mode
 
SimDigammaBackend backend
 
SimDigammaSquareWaveformShape shape
 

Detailed Description

Shared configuration for digamma square stimulus variants.

Member Data Documentation

◆ a

double SimStimulusDigammaSquareConfig::a

Deformation shift parameter (default 0.25).

◆ amplitude

double SimStimulusDigammaSquareConfig::amplitude

Signal amplitude.

◆ backend

SimDigammaBackend SimStimulusDigammaSquareConfig::backend

Backend choice for digamma/trigamma evaluation.

◆ coord

SimStimulusCoordConfig SimStimulusDigammaSquareConfig::coord

Spatial coordinate mapping configuration.

◆ field_index

size_t SimStimulusDigammaSquareConfig::field_index

Target field index.

◆ fixed_clock

bool SimStimulusDigammaSquareConfig::fixed_clock

Lock the driving clock to nominal_dt instead of adaptive dt.

◆ harmonics

double SimStimulusDigammaSquareConfig::harmonics

Number of harmonics for square wave approximation.

◆ kx

double SimStimulusDigammaSquareConfig::kx

Optional wavevector X component (rad / unit).

◆ ky

double SimStimulusDigammaSquareConfig::ky

Optional wavevector Y component (rad / unit).

◆ nominal_dt

double SimStimulusDigammaSquareConfig::nominal_dt

Optional nominal dt when fixed_clock is enabled (<=0 uses actual dt).

◆ omega

double SimStimulusDigammaSquareConfig::omega

Base angular frequency (rad / s).

◆ phase

double SimStimulusDigammaSquareConfig::phase

Global phase offset (radians).

◆ rotation

double SimStimulusDigammaSquareConfig::rotation

Rotation applied when writing into complex fields (radians).

◆ scale_by_dt

bool SimStimulusDigammaSquareConfig::scale_by_dt

When true, scale writes by substep dt; false = dt-independent signal.

◆ shape

SimDigammaSquareWaveformShape SimStimulusDigammaSquareConfig::shape

Waveform shape.

◆ time_offset

double SimStimulusDigammaSquareConfig::time_offset

Additional time offset applied before evaluation.

◆ tolerance

double SimStimulusDigammaSquareConfig::tolerance

Absolute tolerance for adaptive digamma/trigamma (if used).

◆ use_warp

bool SimStimulusDigammaSquareConfig::use_warp

When true, modulate bc by warp field sample.

◆ use_wavevector

bool SimStimulusDigammaSquareConfig::use_wavevector

When true, use (kx,ky) instead of wavenumber+coord.

◆ velocity

double SimStimulusDigammaSquareConfig::velocity

Advection speed for traveling Gaussian envelope (units / s).

◆ warp_bias

double SimStimulusDigammaSquareConfig::warp_bias

Bias added to warp field sample before modulation.

◆ warp_field_index

size_t SimStimulusDigammaSquareConfig::warp_field_index

Optional warp field index for spatial modulation.

◆ warp_mix

double SimStimulusDigammaSquareConfig::warp_mix

Mixing factor for warp modulation.

◆ warp_mode

SimMixerMode SimStimulusDigammaSquareConfig::warp_mode

Warp mixing strategy (sum/multiply/crossfade).

◆ wavenumber

double SimStimulusDigammaSquareConfig::wavenumber

Base spatial wavenumber (rad / unit).


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