#include <so3_types.h>

Data Fields
int	verbosity

int	reality

int	L0

int	L

int	N

so3_sampling_t	sampling_scheme

so3_n_order_t	n_order

so3_storage_t	storage

so3_n_mode_t	n_mode

ssht_dl_method_t	dl_method

int	steerable

Detailed Description

A struct with all parameters that are common to several functions of the API. In general only one struct needs to be created and a const pointer to it is passed around.

Attention: Make sure to use an initializer upon declaration, even if it is left empty. This ensures that all fields are initialized to zero (even if in non-static storage). This way, your code will remain backwards compatible if more fields are added to this struct in the future:
so3_parameters_t parameters = {};

Field Documentation

◆ dl_method

ssht_dl_method_t so3_parameters_t::dl_method

Recursion method to use for computing Wigner functions.

◆ L

int so3_parameters_t::L

Upper harmonic band-limit. Only flmn with l < L will be stored and considered.

◆ L0

int so3_parameters_t::L0

Lower harmonic band-limit. flmn with l < L0 will be zero.

◆ N

int so3_parameters_t::N

Upper orientational band-limit. Only flmn with n < N will be stored.

◆ n_mode

so3_n_mode_t so3_parameters_t::n_mode

Indicates if entire blocks of flm for certain values of n are zero.

◆ n_order

so3_n_order_t so3_parameters_t::n_order

Indicates the order of n-values by which individual flm-blocks are stored.

◆ reality

int so3_parameters_t::reality

A non-zero value indicates that the signal f is real. Not all functions respect this value - instead there may be separate complex and real functions. See the documentation of each function for details.

◆ sampling_scheme

so3_sampling_t so3_parameters_t::sampling_scheme

Sampling scheme to use for samples of the signal f.

◆ steerable

int so3_parameters_t::steerable

A non-zero value indicates that the signal is steerable.

◆ storage

so3_storage_t so3_parameters_t::storage

Type of storage (padded or compact).

◆ verbosity

int so3_parameters_t::verbosity

Detail level for diagnostic console output in range [0,5].

The documentation for this struct was generated from the following file:

include/so3/so3_types.h

Data Fields