![]() |
![]() |
Gwyddion Data Processing Library Reference Manual | ||
---|---|---|---|---|
enum GwyMergeType; enum GwyWatershedStateType; enum GwyPlaneSymmetry; enum Gwy2DCWTWaveletType; enum GwyOrientation; enum GwyTransformDirection; enum GwyDataFieldCached; enum GwyComputationStateType; enum GwyDWTType; enum GwyDWTDenoiseType; enum GwyInterpolationType; enum GwyPlaneFitQuantity; enum GwyWindowingType; enum GwyTipType; enum GwyCorrelationType; enum GwyGrainQuantity; enum GwyDataCompatibilityFlags; enum GwyLineStatQuantity; enum GwyExteriorType; const GwyEnum* gwy_merge_type_get_enum (void); const GwyEnum* gwy_plane_symmetry_get_enum (void); const GwyEnum* gwy_2d_cwt_wavelet_type_get_enum (void); const GwyEnum* gwy_orientation_get_enum (void); const GwyEnum* gwy_dwt_type_get_enum (void); const GwyEnum* gwy_dwt_denoise_type_get_enum (void); const GwyEnum* gwy_interpolation_type_get_enum (void); const GwyEnum* gwy_windowing_type_get_enum (void); const GwyEnum* gwy_correlation_type_get_enum (void); GwyComputationState;
typedef enum { GWY_MERGE_UNION, GWY_MERGE_INTERSECTION } GwyMergeType;
Mask merge type (namely used in grain processing).
typedef enum { GWY_WATERSHED_STATE_INIT, GWY_WATERSHED_STATE_LOCATE, GWY_WATERSHED_STATE_MIN, GWY_WATERSHED_STATE_WATERSHED, GWY_WATERSHED_STATE_MARK, GWY_WATERSHED_STATE_FINISHED } GwyWatershedStateType;
typedef enum { GWY_SYMMETRY_AUTO, GWY_SYMMETRY_PARALLEL, GWY_SYMMETRY_TRIANGULAR, GWY_SYMMETRY_SQUARE, GWY_SYMMETRY_RHOMBIC, GWY_SYMMETRY_HEXAGONAL, GWY_SYMMETRY_LAST } GwyPlaneSymmetry;
Plane symmetry types for rotation correction.
typedef enum { /*< lowercase_name=gwy_2d_cwt_wavelet_type >*/ GWY_2DCWT_GAUSS, GWY_2DCWT_HAT } Gwy2DCWTWaveletType;
typedef enum { GWY_ORIENTATION_HORIZONTAL, GWY_ORIENTATION_VERTICAL } GwyOrientation;
Orientation type.
typedef enum { GWY_TRANSFORM_DIRECTION_BACKWARD = -1, GWY_TRANSFORM_DIRECTION_FORWARD = 1 } GwyTransformDirection;
Transform (namely integral transform) direction.
In FFT, it is equal to sign of the exponent, that is backward transform uses -1, forward transform +1.
typedef enum { GWY_DATA_FIELD_CACHE_MIN = 0, GWY_DATA_FIELD_CACHE_MAX, GWY_DATA_FIELD_CACHE_SUM, GWY_DATA_FIELD_CACHE_RMS, GWY_DATA_FIELD_CACHE_MED, GWY_DATA_FIELD_CACHE_ARF, GWY_DATA_FIELD_CACHE_ART, GWY_DATA_FIELD_CACHE_ARE, GWY_DATA_FIELD_CACHE_SIZE = 30 } GwyDataFieldCached;
Cached data field quantity type.
There should be little need to this enum directly except in libgwyprocess methods.
typedef enum { GWY_COMPUTATION_STATE_INIT, GWY_COMPUTATION_STATE_ITERATE, GWY_COMPUTATION_STATE_FINISHED } GwyComputationStateType;
Common iterative computation iterator state type.
typedef enum { GWY_DWT_HAAR, GWY_DWT_DAUB4, GWY_DWT_DAUB6, GWY_DWT_DAUB8, GWY_DWT_DAUB12, GWY_DWT_DAUB20 } GwyDWTType;
typedef enum { GWY_DWT_DENOISE_UNIVERSAL, GWY_DWT_DENOISE_SCALE_ADAPTIVE, GWY_DWT_DENOISE_SPACE_ADAPTIVE } GwyDWTDenoiseType;
typedef enum { GWY_INTERPOLATION_NONE = 0, GWY_INTERPOLATION_ROUND = 1, GWY_INTERPOLATION_LINEAR = 2, GWY_INTERPOLATION_BILINEAR = GWY_INTERPOLATION_LINEAR, GWY_INTERPOLATION_KEY = 3, GWY_INTERPOLATION_BSPLINE = 4, GWY_INTERPOLATION_OMOMS = 5, GWY_INTERPOLATION_NNA = 6, GWY_INTERPOLATION_SCHAUM = 7 } GwyInterpolationType;
Interpolation types.
GWY_INTERPOLATION_NONE |
No interpolation at all, resulting values are not defined, it must not be used for interpolation. It can be used in resize operations discarding original data. |
GWY_INTERPOLATION_ROUND |
Round interpolation (more precisely symmetric nearest neighbour interpolation). |
GWY_INTERPOLATION_LINEAR |
Linear interpolation. |
GWY_INTERPOLATION_BILINEAR |
Old name for GWY_INTERPOLATION_LINEAR . This
is a misnomer because it in fact denotes linear
interpolation of arbitrary dimension. Use
GWY_INTERPOLATION_LINEAR instead.
|
GWY_INTERPOLATION_KEY |
Cubic Key's interpolation (with a=-1/2). |
GWY_INTERPOLATION_BSPLINE |
B-spline interpolation. This interpolation type is misimplemented and should not be used. |
GWY_INTERPOLATION_OMOMS |
Omoms interpolation. This interpolation type is misimplemented and should not be used. |
GWY_INTERPOLATION_NNA |
Nearest neighbour approximation. |
GWY_INTERPOLATION_SCHAUM |
Cubic Schaum interpolation. |
typedef enum { GWY_PLANE_FIT_A = 1, GWY_PLANE_FIT_BX, GWY_PLANE_FIT_BY, GWY_PLANE_FIT_ANGLE, GWY_PLANE_FIT_SLOPE, GWY_PLANE_FIT_S0, GWY_PLANE_FIT_S0_REDUCED } GwyPlaneFitQuantity;
Local plane fitting quantity to request from
gwy_data_field_area_fit_local_planes()
and similar functions.
typedef enum { GWY_WINDOWING_NONE = 0, GWY_WINDOWING_HANN = 1, GWY_WINDOWING_HAMMING = 2, GWY_WINDOWING_BLACKMANN = 3, GWY_WINDOWING_LANCZOS = 4, GWY_WINDOWING_WELCH = 5, GWY_WINDOWING_RECT = 6 } GwyWindowingType;
Frequency windowing type.
typedef enum { GWY_TIP_PYRAMIDE = 0, GWY_TIP_CONTACT = 1, GWY_TIP_NONCONTACT = 2, GWY_TIP_DELTA = 3 } GwyTipType;
typedef enum { GWY_CORRELATION_NORMAL = 0, GWY_CORRELATION_FFT = 1, GWY_CORRELATION_POC = 2 } GwyCorrelationType;
typedef enum { GWY_GRAIN_VALUE_PROJECTED_AREA = 0, GWY_GRAIN_VALUE_EQUIV_SQUARE_SIDE = 1, GWY_GRAIN_VALUE_EQUIV_DISC_RADIUS = 2, GWY_GRAIN_VALUE_SURFACE_AREA = 3, GWY_GRAIN_VALUE_MAXIMUM = 4, GWY_GRAIN_VALUE_MINIMUM = 5, GWY_GRAIN_VALUE_MEAN = 6, GWY_GRAIN_VALUE_MEDIAN = 7, GWY_GRAIN_VALUE_FLAT_BOUNDARY_LENGTH = 10, GWY_GRAIN_VALUE_MINIMUM_BOUND_SIZE = 12, GWY_GRAIN_VALUE_MINIMUM_BOUND_ANGLE = 13, GWY_GRAIN_VALUE_MAXIMUM_BOUND_SIZE = 14, GWY_GRAIN_VALUE_MAXIMUM_BOUND_ANGLE = 15, GWY_GRAIN_VALUE_VOLUME_0 = 18, GWY_GRAIN_VALUE_VOLUME_MIN = 19, GWY_GRAIN_VALUE_VOLUME_LAPLACE = 20 } GwyGrainQuantity;
Grain quantity to request from gwy_data_field_grains_get_distribution()
and similar functions.
typedef enum { GWY_DATA_COMPATIBILITY_RES = 1 << 0, GWY_DATA_COMPATIBILITY_REAL = 1 << 1, GWY_DATA_COMPATIBILITY_MEASURE = 1 << 2, GWY_DATA_COMPATIBILITY_LATERAL = 1 << 3, GWY_DATA_COMPATIBILITY_VALUE = 1 << 4, GWY_DATA_COMPATIBILITY_ALL = 0x001f } GwyDataCompatibilityFlags;
Data line and field compatibility flags.
typedef enum { GWY_LINE_STAT_MEAN, GWY_LINE_STAT_MEDIAN, GWY_LINE_STAT_MINIMUM, GWY_LINE_STAT_MAXIMUM, GWY_LINE_STAT_RMS, GWY_LINE_STAT_LENGTH, GWY_LINE_STAT_SLOPE, GWY_LINE_STAT_TAN_BETA0 } GwyLineStatQuantity;
Line statistical quantities to be requested with
gwy_data_field_area_get_line_stats()
.
Since 2.2
typedef enum { GWY_EXTERIOR_UNDEFINED, GWY_EXTERIOR_BORDER_EXTEND, GWY_EXTERIOR_MIRROR_EXTEND, GWY_EXTERIOR_PERIODIC, GWY_EXTERIOR_FIXED_VALUE } GwyExteriorType;
Methods to handle pixels outside data.
Many methods currently use a fixed metod of handling of exterior pixels, for example area calculation uses extension (border and mirror coincide), convolution uses mirror extension, rotation fills exterior with a fixed value.
Since 2.2
const GwyEnum* gwy_merge_type_get_enum (void);
Returns GwyEnum for GwyMergeType enum type.
const GwyEnum* gwy_plane_symmetry_get_enum (void);
Returns GwyEnum for GwyPlaneSymmetry enum type.
const GwyEnum* gwy_2d_cwt_wavelet_type_get_enum (void);
Returns GwyEnum for Gwy2DCWTWaveletType enum type.
const GwyEnum* gwy_orientation_get_enum (void);
Returns GwyEnum for GwyOrientation enum type.
const GwyEnum* gwy_dwt_type_get_enum (void);
Returns GwyEnum for GwyDWTType enum type.
const GwyEnum* gwy_dwt_denoise_type_get_enum (void);
Returns GwyEnum for GwyDWTDenoiseType enum type.
const GwyEnum* gwy_interpolation_type_get_enum (void);
Returns GwyEnum for GwyInterpolationType enum type.
const GwyEnum* gwy_windowing_type_get_enum (void);
Returns GwyEnum for GwyWindowingType enum type.
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:
GwyComputationStateType *state; state = gwy_data_field_foo_init(GwyDataField *data_field, ...); do { gwy_data_field_foo_iteration(state); /* Update progress using state->fraction, let Gtk+ main loop run, check for abort, ... */ if (aborted) { gwy_data_field_foo_finalize(state); return FALSE; } } while (state->state != GWY_COMPUTATION_STATE_FINISHED); gwy_data_field_foo_finalize(state); return TRUE;
guint state ; |
Current computation state, usually of GwyComputationStateType, but particular iterators can define their own types. |
gdouble fraction ; |
Fraction of computation completed. For staged algorithms, the fraction refers to the current stage only. |