phase_feature.h File Reference

Phase-feature extraction for real and complex fields. More...

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

Include dependency graph for phase_feature.h:

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

Go to the source code of this file.

Classes
struct	SimPhaseFeatureOperatorConfig
	Configuration for phase-feature extraction. More...

Typedefs
typedef struct SimPhaseFeatureOperatorConfig	SimPhaseFeatureOperatorConfig
	Configuration for phase-feature extraction.

Functions
SimResult	sim_add_phase_feature_operator (struct SimContext *context, const SimPhaseFeatureOperatorConfig *config, size_t *out_index)
	Register a phase-feature extraction operator.
SimResult	sim_phase_feature_config (struct SimContext *context, size_t operator_index, SimPhaseFeatureOperatorConfig *out_config)
	Copy the current phase-feature configuration from a registered operator.
SimResult	sim_phase_feature_update (struct SimContext *context, size_t operator_index, const SimPhaseFeatureOperatorConfig *config)
	Replace or renormalize a registered phase-feature configuration.

Detailed Description

Phase-feature extraction for real and complex fields.

Function Documentation

sim_add_phase_feature_operator()

SimResult sim_add_phase_feature_operator	(	struct SimContext *	context,
		const SimPhaseFeatureOperatorConfig *	config,
		size_t *	out_index
	)

Register a phase-feature extraction operator.

Parameters

	context	Simulation context that will own the operator.
	config	Optional phase-feature 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 argument validation, field compatibility checks, allocation, or split registration.

sim_phase_feature_config()

SimResult sim_phase_feature_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimPhaseFeatureOperatorConfig *	out_config
	)

Copy the current phase-feature configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_phase_feature_operator().
[out]	out_config	Receives the 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 phase-feature state.

sim_phase_feature_update()

SimResult sim_phase_feature_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimPhaseFeatureOperatorConfig *	config
	)

Replace or renormalize a registered phase-feature configuration.

Passing NULL for config keeps the current 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 phase-feature operator to update.
config	Optional replacement configuration.

Returns

SIM_RESULT_OK on success, or an error code from lookup, field compatibility checks, or state validation.