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

Parameterization for Gaussian-envelope stimulus operators. More...

#include <gaussian.h>

Collaboration diagram for SimStimulusGaussianConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double sigma_x
 
double sigma_y
 
double time_offset
 
SimStimulusCoordConfig coord
 
double rotation
 
double nominal_dt
 
bool fixed_clock
 
bool scale_by_dt
 

Detailed Description

Parameterization for Gaussian-envelope stimulus operators.

Member Data Documentation

◆ amplitude

double SimStimulusGaussianConfig::amplitude

Peak amplitude of the envelope.

◆ coord

SimStimulusCoordConfig SimStimulusGaussianConfig::coord

Spatial coordinate mapping configuration.

◆ field_index

size_t SimStimulusGaussianConfig::field_index

Target field index.

◆ fixed_clock

bool SimStimulusGaussianConfig::fixed_clock

Hold the driving clock to nominal_dt when true.

◆ nominal_dt

double SimStimulusGaussianConfig::nominal_dt

Nominal dt used when fixed_clock is true.

◆ rotation

double SimStimulusGaussianConfig::rotation

Phase rotation applied when writing complex outputs (radians).

◆ scale_by_dt

bool SimStimulusGaussianConfig::scale_by_dt

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

◆ sigma_x

double SimStimulusGaussianConfig::sigma_x

Gaussian standard deviation along X (units).

◆ sigma_y

double SimStimulusGaussianConfig::sigma_y

Gaussian standard deviation along Y (units).

◆ time_offset

double SimStimulusGaussianConfig::time_offset

Time offset applied before evaluating the envelope.


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