morlet_field.h File Reference

Morlet wavelet field stimulus with explicit coordinate controls. More...

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

Include dependency graph for morlet_field.h:

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

Go to the source code of this file.

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

Typedefs
typedef struct SimStimulusMorletFieldConfig	SimStimulusMorletFieldConfig
	Configuration for a multi-scale Morlet wavelet field stimulus.

Functions
SimResult	sim_add_stimulus_morlet_field_operator (struct SimContext *context, const SimStimulusMorletFieldConfig *config, size_t *out_index)
	Register a Morlet wavelet field stimulus operator.
SimResult	sim_stimulus_morlet_field_config (struct SimContext *context, size_t operator_index, SimStimulusMorletFieldConfig *out_config)
	Copy the current Morlet-field configuration from a registered operator.
SimResult	sim_stimulus_morlet_field_update (struct SimContext *context, size_t operator_index, const SimStimulusMorletFieldConfig *config)
	Replace or renormalize a registered Morlet-field configuration.

Detailed Description

Morlet wavelet field stimulus with explicit coordinate controls.

Function Documentation

sim_add_stimulus_morlet_field_operator()

SimResult sim_add_stimulus_morlet_field_operator	(	struct SimContext *	context,
		const SimStimulusMorletFieldConfig *	config,
		size_t *	out_index
	)

Register a Morlet wavelet field stimulus operator.

The implementation copies and normalizes config, then registers a split operator that sums the requested Morlet scales on the target field.

Parameters

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

SimResult sim_stimulus_morlet_field_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusMorletFieldConfig *	out_config
	)

Copy the current Morlet-field configuration from a registered operator.

Parameters

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

SimResult sim_stimulus_morlet_field_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusMorletFieldConfig *	config
	)

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

Returns

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