#include <s2let_types.h>

Data Fields
int	verbosity

int	reality

int	upsample

double	B

int	L

int	J_min

int	N

int	spin

int	original_spin

s2let_sampling_t	sampling_scheme

ssht_dl_method_t	dl_method

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:
s2let_parameters_t parameters = {};

Field Documentation

◆ B

double s2let_parameters_t::B

Wavelet parameter which determines the scale factor between consecutive wavelet scales.

◆ dl_method

ssht_dl_method_t s2let_parameters_t::dl_method

Recursion method to use for computing Wigner functions.

◆ J_min

int s2let_parameters_t::J_min

First wavelet scale to be used.

◆ L

int s2let_parameters_t::L

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

◆ N

int s2let_parameters_t::N

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

◆ original_spin

int s2let_parameters_t::original_spin

If normalization has value S2LET_WAV_NORM_SPIN_LOWERED this parameter indicates which spin number the wavelets were lowered from. Otherwise, it is ignored.

◆ reality

int s2let_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

s2let_sampling_t s2let_parameters_t::sampling_scheme

Sampling scheme to use for samples of the signal f as well as the wavelets.

◆ spin

int s2let_parameters_t::spin

Spin number of the signal f.

◆ upsample

int s2let_parameters_t::upsample

A non-zero value indicates that the signal is stored in a full-resolution format, where each wavelet scale is upsampled to use the same amount of pixels. A zero-value indicates that the signal uses only as many pixels as necessary for each wavelet scale's upper harmonic bandlimit. This can lead to significant storage and time savings and is the default behaviour.

◆ verbosity

int s2let_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/s2let_types.h

Data Fields