moire.h File Reference

Moire interference stimulus for 1D/2D coordinate systems. More...

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

Include dependency graph for moire.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusMoireConfig
	Configuration for two-grating moire interference stimuli. More...

Typedefs
typedef struct SimStimulusMoireConfig	SimStimulusMoireConfig
	Configuration for two-grating moire interference stimuli.

Functions
SimResult	sim_add_stimulus_moire_operator (struct SimContext *context, const SimStimulusMoireConfig *config, size_t *out_index)
	Register a moire interference stimulus operator.
SimResult	sim_stimulus_moire_config (struct SimContext *context, size_t operator_index, SimStimulusMoireConfig *out_config)
	Copy the current moire configuration from a registered operator.
SimResult	sim_stimulus_moire_update (struct SimContext *context, size_t operator_index, const SimStimulusMoireConfig *config)
	Replace or renormalize a registered moire stimulus configuration.

Detailed Description

Moire interference stimulus for 1D/2D coordinate systems.

The operator adds the interference of two nearby gratings: m = 0.5 * (cos(theta_a) + cos(theta_b)) with either scalar coordinate mapping (coord) or explicit 2D wavevectors.

Function Documentation

sim_add_stimulus_moire_operator()

SimResult sim_add_stimulus_moire_operator	(	struct SimContext *	context,
		const SimStimulusMoireConfig *	config,
		size_t *	out_index
	)

Register a moire interference stimulus operator.

The implementation copies and normalizes config, then registers a split operator that writes the two-grating interference pattern.

Parameters

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

SimResult sim_stimulus_moire_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusMoireConfig *	out_config
	)

Copy the current moire configuration from a registered operator.

Parameters

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

SimResult sim_stimulus_moire_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusMoireConfig *	config
	)

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

Returns

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