steerable_wavelet.h File Reference

Steerable wavelet stimulus (Simoncelli/Riesz-style) with explicit coord controls. More...

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

Include dependency graph for steerable_wavelet.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusSteerableWaveletConfig
	Configuration for steerable wavelet stimulus families and scales. More...

Typedefs
typedef enum SimStimulusSteerableWaveletFamily	SimStimulusSteerableWaveletFamily
	Steerable wavelet families available to the stimulus.
typedef struct SimStimulusSteerableWaveletConfig	SimStimulusSteerableWaveletConfig
	Configuration for steerable wavelet stimulus families and scales.

Enumerations
enum	SimStimulusSteerableWaveletFamily { SIM_STIMULUS_STEERABLE_WAVELET_SIMONCELLI = 0 , SIM_STIMULUS_STEERABLE_WAVELET_RIESZ = 1 }
	Steerable wavelet families available to the stimulus. More...

Functions
SimResult	sim_add_stimulus_steerable_wavelet_operator (struct SimContext *context, const SimStimulusSteerableWaveletConfig *config, size_t *out_index)
	Register a steerable wavelet stimulus operator.
SimResult	sim_stimulus_steerable_wavelet_config (struct SimContext *context, size_t operator_index, SimStimulusSteerableWaveletConfig *out_config)
	Copy the current steerable-wavelet configuration from a registered operator.
SimResult	sim_stimulus_steerable_wavelet_update (struct SimContext *context, size_t operator_index, const SimStimulusSteerableWaveletConfig *config)
	Replace or renormalize a registered steerable-wavelet configuration.

Detailed Description

Steerable wavelet stimulus (Simoncelli/Riesz-style) with explicit coord controls.

Enumeration Type Documentation

SimStimulusSteerableWaveletFamily

enum SimStimulusSteerableWaveletFamily

Steerable wavelet families available to the stimulus.

Enumerator
SIM_STIMULUS_STEERABLE_WAVELET_SIMONCELLI	Simoncelli-style wavelet family.
SIM_STIMULUS_STEERABLE_WAVELET_RIESZ	Riesz-style wavelet family.

Function Documentation

sim_add_stimulus_steerable_wavelet_operator()

SimResult sim_add_stimulus_steerable_wavelet_operator	(	struct SimContext *	context,
		const SimStimulusSteerableWaveletConfig *	config,
		size_t *	out_index
	)

Register a steerable wavelet stimulus operator.

The implementation copies and normalizes config, prepares the requested wavelet family, and registers the operator on the target field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional steerable-wavelet 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, buffer setup, or split-operator registration.

sim_stimulus_steerable_wavelet_config()

SimResult sim_stimulus_steerable_wavelet_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusSteerableWaveletConfig *	out_config
	)

Copy the current steerable-wavelet configuration from a registered operator.

Parameters

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

SimResult sim_stimulus_steerable_wavelet_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusSteerableWaveletConfig *	config
	)

Replace or renormalize a registered steerable-wavelet configuration.

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

Parameters

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

Returns

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