zone_plate.h File Reference

Fresnel-style zone plate stimulus with quadratic radial phase. More...

#include "coords.h"
#include "oakfield/operator_split.h"
#include <stdbool.h>
#include <stddef.h>

Include dependency graph for zone_plate.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SimStimulusZonePlateConfig
	Configuration for a Fresnel-style zone plate stimulus. More...

Typedefs
typedef struct SimStimulusZonePlateConfig	SimStimulusZonePlateConfig
	Configuration for a Fresnel-style zone plate stimulus.

Functions
SimResult	sim_add_stimulus_zone_plate_operator (struct SimContext *context, const SimStimulusZonePlateConfig *config, size_t *out_index)
	Register a Fresnel-style zone plate stimulus operator.
SimResult	sim_stimulus_zone_plate_config (struct SimContext *context, size_t operator_index, SimStimulusZonePlateConfig *out_config)
	Copy the current zone-plate configuration from a registered operator.
SimResult	sim_stimulus_zone_plate_update (struct SimContext *context, size_t operator_index, const SimStimulusZonePlateConfig *config)
	Replace or renormalize a registered zone-plate stimulus configuration.

Detailed Description

Fresnel-style zone plate stimulus with quadratic radial phase.

Evaluates a local plate frame (u, v) and injects A * exp(-0.5 * ((u/a_u)^2 + (v/a_v)^2))

• exp(i * (kappa * ((u/s_u)^2 + (v/s_v)^2) - omega * (t + t_0) + phi)), where the local frame can drift and rotate over time.

Real fields receive the real component. Complex fields receive the full complex pattern with an additional global rotation.

Function Documentation

sim_add_stimulus_zone_plate_operator()

SimResult sim_add_stimulus_zone_plate_operator	(	struct SimContext *	context,
		const SimStimulusZonePlateConfig *	config,
		size_t *	out_index
	)

Register a Fresnel-style zone plate stimulus operator.

The implementation copies and normalizes config, then registers a split operator that writes the quadratic radial phase pattern into the target field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional zone-plate configuration; NULL selects normalized defaults.
[out]	out_index	Optional destination for the registered operator index.

Returns

SIM_RESULT_OK on success, or an error code from validation, allocation, or split-operator registration.

sim_stimulus_zone_plate_config()

SimResult sim_stimulus_zone_plate_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusZonePlateConfig *	out_config
	)

Copy the current zone-plate configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_stimulus_zone_plate_operator().
[out]	out_config	Receives the operator's normalized configuration.

Returns

SIM_RESULT_OK on success, SIM_RESULT_INVALID_ARGUMENT for NULL pointers, SIM_RESULT_NOT_FOUND for a missing operator, or SIM_RESULT_INVALID_STATE when the operator has no stimulus state.

sim_stimulus_zone_plate_update()

SimResult sim_stimulus_zone_plate_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusZonePlateConfig *	config
	)

Replace or renormalize a registered zone-plate stimulus configuration.

Passing NULL for config keeps the existing configuration and reapplies normalization. A successful update refreshes symbolic state and invalidates the scheduler plan.

Parameters

context	Simulation context containing the operator.
operator_index	Index of the zone-plate operator to update.
config	Optional replacement configuration.

Returns

SIM_RESULT_OK on success, or an error code if lookup or state validation fails.