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

Shared coordinate mapping configuration used by stimulus operators. More...

#include <coords.h>

Public Attributes

SimStimulusCoordMode mode
 
SimStimulusCoordAxis axis
 
SimStimulusSeparableMode combine
 
double angle
 
double origin_x
 
double origin_y
 
double spacing_x
 
double spacing_y
 
double center_x
 
double center_y
 
double velocity_x
 
double velocity_y
 
double ellipse_u
 
double ellipse_v
 
double spiral_arms
 
double spiral_pitch
 
double spiral_phase
 
double spiral_angular_velocity
 

Detailed Description

Shared coordinate mapping configuration used by stimulus operators.

Member Data Documentation

◆ angle

double SimStimulusCoordConfig::angle

Angle for angled mode (radians).

◆ axis

SimStimulusCoordAxis SimStimulusCoordConfig::axis

Axis used for axis mode.

◆ center_x

double SimStimulusCoordConfig::center_x

Radial center X (units).

◆ center_y

double SimStimulusCoordConfig::center_y

Radial center Y (units).

◆ combine

SimStimulusSeparableMode SimStimulusCoordConfig::combine

Separable combine rule.

◆ ellipse_u

double SimStimulusCoordConfig::ellipse_u

Elliptic semi-axis in the local U frame.

◆ ellipse_v

double SimStimulusCoordConfig::ellipse_v

Elliptic semi-axis in the local V frame.

◆ mode

SimStimulusCoordMode SimStimulusCoordConfig::mode

Coordinate mapping mode.

◆ origin_x

double SimStimulusCoordConfig::origin_x

Spatial origin X (units).

◆ origin_y

double SimStimulusCoordConfig::origin_y

Spatial origin Y (units).

◆ spacing_x

double SimStimulusCoordConfig::spacing_x

Spacing in X (units).

◆ spacing_y

double SimStimulusCoordConfig::spacing_y

Spacing in Y (units).

◆ spiral_angular_velocity

double SimStimulusCoordConfig::spiral_angular_velocity

Angular drift rate for spiral mode.

◆ spiral_arms

double SimStimulusCoordConfig::spiral_arms

Angular arm count multiplier for spiral mode.

◆ spiral_phase

double SimStimulusCoordConfig::spiral_phase

Additive phase offset for spiral mode (radians).

◆ spiral_pitch

double SimStimulusCoordConfig::spiral_pitch

Radial pitch multiplier for spiral mode.

◆ velocity_x

double SimStimulusCoordConfig::velocity_x

Sampling-frame drift velocity X (units/s).

◆ velocity_y

double SimStimulusCoordConfig::velocity_y

Sampling-frame drift velocity Y (units/s).


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