log_polar.h File Reference

Log-polar interference stimulus with optional spiral phase drift. More...

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

Include dependency graph for log_polar.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusLogPolarConfig
	Configuration for log-polar interference stimulus fields. More...

Typedefs
typedef struct SimStimulusLogPolarConfig	SimStimulusLogPolarConfig
	Configuration for log-polar interference stimulus fields.

Functions
SimResult	sim_add_stimulus_log_polar_operator (struct SimContext *context, const SimStimulusLogPolarConfig *config, size_t *out_index)
	Register a log-polar interference stimulus operator.
SimResult	sim_stimulus_log_polar_config (struct SimContext *context, size_t operator_index, SimStimulusLogPolarConfig *out_config)
	Copy the current log-polar configuration from a registered operator.
SimResult	sim_stimulus_log_polar_update (struct SimContext *context, size_t operator_index, const SimStimulusLogPolarConfig *config)
	Replace or renormalize a registered log-polar stimulus configuration.

Detailed Description

Log-polar interference stimulus with optional spiral phase drift.

Builds a phase field from log-radius and polar angle: phi = k_r * log(r + eps) + m * theta - omega * (t + t_0) + phi_0 and writes A * cos(phi) to real fields or A * exp(i * phi) to complex fields.

Function Documentation

sim_add_stimulus_log_polar_operator()

SimResult sim_add_stimulus_log_polar_operator	(	struct SimContext *	context,
		const SimStimulusLogPolarConfig *	config,
		size_t *	out_index
	)

Register a log-polar interference stimulus operator.

The implementation copies and normalizes config, then registers a split operator that evaluates the log-radius and angular phase field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional log-polar 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_log_polar_config()

SimResult sim_stimulus_log_polar_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusLogPolarConfig *	out_config
	)

Copy the current log-polar configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_stimulus_log_polar_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_log_polar_update()

SimResult sim_stimulus_log_polar_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusLogPolarConfig *	config
	)

Replace or renormalize a registered log-polar 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 log-polar operator to update.
config	Optional replacement configuration.

Returns

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