gwy_merge_type_get_enum()

const GwyEnum *
gwy_merge_type_get_enum (void);

Returns GwyEnum for GwyMergeType enum type.

gwy_masking_type_get_enum()

const GwyEnum *
gwy_masking_type_get_enum (void);

Returns GwyEnum for GwyMaskingType enum type.

gwy_orientation_get_enum()

const GwyEnum *
gwy_orientation_get_enum (void);

Returns GwyEnum for GwyOrientation enum type.

gwy_interpolation_type_get_enum()

const GwyEnum *
gwy_interpolation_type_get_enum (void);

Returns GwyEnum for GwyInterpolationType enum type.

gwy_windowing_type_get_enum()

const GwyEnum *
gwy_windowing_type_get_enum (void);

Returns GwyEnum for GwyWindowingType enum type.

gwy_correlation_type_get_enum()

const GwyEnum *
gwy_correlation_type_get_enum (void);

Returns GwyEnum for GwyCorrelationType enum type.

gwy_direction_flags_get_enum()

const GwyEnum *
gwy_direction_flags_get_enum (void);

Returns GwyEnum for GwyDirectionFlags enum type.

gwy_sign_flags_get_enum()

const GwyEnum *
gwy_sign_flags_get_enum (void);

Returns GwyEnum for GwySignFlags enum type.

gwy_computation_state_get_state()

gint
gwy_computation_state_get_state (GwyComputationState *compstate);

Gets the state field of a computation state struct.

Useful mostly for language bindings.

gwy_computation_state_get_fraction()

gdouble
gwy_computation_state_get_fraction (GwyComputationState *compstate);

Gets the fraction field of a computation state struct.

enum GwyOrientation

Orientation type.

The enum is identical to GtkOrientation and the values should be interchangeable. It is, however, available in non-GUI context.

See also GwyDirectionFlags for flags, if the directions are not exclusive (and possibly ‘none’ is also an option).

enum GwyDirectionFlags

Orientation flags.

If needed, zero (no flag set) can be used to represent no direction.

See also GwyOrientation for the exclusive variant (the orientation is always exactly one of the two).

enum GwySignFlags

Sign flags.

If needed, zero (no flag set) can be used to represent neither sign.

enum GwyTransformDirection

Transform (namely integral transform) direction.

In FFT, it is equal to sign of the exponent, that is the backward transform uses -1, the forward transform +1. This is the opposite sign convention to FFTW (for instance), so care must be taken when mixing operations.

enum GwyMergeType

Mask merge type (namely used in grain processing).

enum GwyMaskingType

Mask handling in procedures that can apply masking.

Note at present many procedures do not have a masking argument and hence cannot apply masks in exclude mode.

enum GwyComputationStateType

Common iterative computation iterator state type.

enum GwyPlaneFitQuantity

Local plane fitting quantity to request from gwy_field_area_fit_local_planes() and similar functions.

enum GwyWindowingType

Frequency windowing type.

enum GwyCorrSearchType

Type of correlation search output.

enum GwyRotateResizeType

Type of rotated data field size determination method.

GwyComputationState

typedef struct {
    guint state;
    gdouble fraction;
} GwyComputationState;

State of iterative computation.

Iterators usually append their own private state data, therefore it must not be assumed the public fields state and fraction are the only fields.

A typical iteration, assuming an iterative computation `foo' with the default GwyComputationStateType state could be:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

GwyComputationStateType *state;

state = gwy_field_foo_init(GwyField *field, ...);
do {
    gwy_field_foo_iteration(state);
    /* Update progress using state->fraction,
        let Gtk+ main loop run, check for abort, ... */
    if (aborted) {
        gwy_field_foo_finalize(state);
        return FALSE;
    }
} while (state->state != GWY_COMPUTATION_STATE_FINISHED);
gwy_field_foo_finalize(state);
return TRUE;