SimStimulusOpticalVortexConfig Struct Reference

Configuration for an optical vortex beam with phase winding. More...

#include <optical_vortex.h>

Collaboration diagram for SimStimulusOpticalVortexConfig:

Public Attributes
size_t	field_index
double	amplitude
int	charge
double	waist_x
double	waist_y
double	center_u
double	center_v
double	velocity_u
double	velocity_v
double	orientation
double	orientation_rate
double	omega
double	phase
SimStimulusCoordConfig	coord
double	time_offset
double	rotation
bool	scale_by_dt

Detailed Description

Configuration for an optical vortex beam with phase winding.

Member Data Documentation

amplitude

double SimStimulusOpticalVortexConfig::amplitude

Output amplitude scale.

center_u

double SimStimulusOpticalVortexConfig::center_u

Beam center in local u.

center_v

double SimStimulusOpticalVortexConfig::center_v

Beam center in local v.

charge

int SimStimulusOpticalVortexConfig::charge

Topological charge l controlling phase winding.

coord

SimStimulusCoordConfig SimStimulusOpticalVortexConfig::coord

Coordinate mapping into the local beam frame.

field_index

size_t SimStimulusOpticalVortexConfig::field_index

Target field index.

omega

double SimStimulusOpticalVortexConfig::omega

Temporal angular frequency.

orientation

double SimStimulusOpticalVortexConfig::orientation

Local beam orientation angle.

orientation_rate

double SimStimulusOpticalVortexConfig::orientation_rate

Beam orientation drift (rad/s).

phase

double SimStimulusOpticalVortexConfig::phase

Phase offset.

rotation

double SimStimulusOpticalVortexConfig::rotation

Global complex-output rotation.

scale_by_dt

bool SimStimulusOpticalVortexConfig::scale_by_dt

Scale writes by dt when true.

time_offset

double SimStimulusOpticalVortexConfig::time_offset

Additional time offset before evaluation.

velocity_u

double SimStimulusOpticalVortexConfig::velocity_u

Beam center drift velocity in u.

velocity_v

double SimStimulusOpticalVortexConfig::velocity_v

Beam center drift velocity in v.

waist_x

double SimStimulusOpticalVortexConfig::waist_x

Beam waist along local u.

waist_y

double SimStimulusOpticalVortexConfig::waist_y

Beam waist along local v.

---

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

• optical_vortex.h