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

Configuration for a multi-scale Morlet wavelet field stimulus. More...

#include <morlet_field.h>

Collaboration diagram for SimStimulusMorletFieldConfig:

Public Attributes

size_t field_index
 
double amplitude
 
unsigned int scale_count
 
double base_wavenumber
 
double scale_growth
 
double sigma_base
 
double sigma_growth
 
double center_u
 
double center_v
 
double velocity_u
 
double velocity_v
 
double orientation
 
double orientation_rate
 
double kx
 
double ky
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
double rotation
 
bool use_wavevector
 
bool zero_mean
 
bool scale_by_dt
 

Detailed Description

Configuration for a multi-scale Morlet wavelet field stimulus.

Member Data Documentation

◆ amplitude

double SimStimulusMorletFieldConfig::amplitude

Output amplitude scale.

◆ base_wavenumber

double SimStimulusMorletFieldConfig::base_wavenumber

Base carrier wavenumber (rad / unit).

◆ center_u

double SimStimulusMorletFieldConfig::center_u

Center in local u coordinate.

◆ center_v

double SimStimulusMorletFieldConfig::center_v

Center in local v coordinate.

◆ coord

SimStimulusCoordConfig SimStimulusMorletFieldConfig::coord

Coordinate mapping when not wavevector mode.

◆ field_index

size_t SimStimulusMorletFieldConfig::field_index

Target field index.

◆ kx

double SimStimulusMorletFieldConfig::kx

Optional wavevector X component.

◆ ky

double SimStimulusMorletFieldConfig::ky

Optional wavevector Y component.

◆ omega

double SimStimulusMorletFieldConfig::omega

Temporal angular frequency (rad/s).

◆ orientation

double SimStimulusMorletFieldConfig::orientation

Wavelet orientation angle (radians).

◆ orientation_rate

double SimStimulusMorletFieldConfig::orientation_rate

Orientation angular drift (rad/s).

◆ phase

double SimStimulusMorletFieldConfig::phase

Global phase offset (radians).

◆ rotation

double SimStimulusMorletFieldConfig::rotation

Complex-output rotation (radians).

◆ scale_by_dt

bool SimStimulusMorletFieldConfig::scale_by_dt

Scale writes by dt when true.

◆ scale_count

unsigned int SimStimulusMorletFieldConfig::scale_count

Number of Morlet scales.

◆ scale_growth

double SimStimulusMorletFieldConfig::scale_growth

Geometric growth factor for wavenumber.

◆ sigma_base

double SimStimulusMorletFieldConfig::sigma_base

Base Gaussian envelope width (units).

◆ sigma_growth

double SimStimulusMorletFieldConfig::sigma_growth

Geometric growth factor for envelope width.

◆ time_offset

double SimStimulusMorletFieldConfig::time_offset

Additional time offset before evaluation.

◆ use_wavevector

bool SimStimulusMorletFieldConfig::use_wavevector

Use (kx, ky) projection basis.

◆ velocity_u

double SimStimulusMorletFieldConfig::velocity_u

Center drift velocity in u (units/s).

◆ velocity_v

double SimStimulusMorletFieldConfig::velocity_v

Center drift velocity in v (units/s).

◆ zero_mean

bool SimStimulusMorletFieldConfig::zero_mean

Apply Morlet zero-mean correction.


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