![]() |
![]() |
Gwyddion Data Processing Library Reference Manual | ![]() |
|
---|---|---|---|---|
Top | Description | Object Hierarchy |
#include <libprocess/gwyprocess.h> struct GwyGrainValue; struct GwyGrainValueClass; enum GwyGrainValueGroup; enum GwyGrainValueFlags; GwyGrainValueData; GwyGrainValueGroup gwy_grain_value_get_group (GwyGrainValue *gvalue
); const gchar * gwy_grain_value_get_symbol (GwyGrainValue *gvalue
); void gwy_grain_value_set_symbol (GwyGrainValue *gvalue
,const gchar *symbol
); const gchar * gwy_grain_value_get_symbol_markup (GwyGrainValue *gvalue
); void gwy_grain_value_set_symbol_markup (GwyGrainValue *gvalue
,const gchar *symbol
); gint gwy_grain_value_get_power_xy (GwyGrainValue *gvalue
); void gwy_grain_value_set_power_xy (GwyGrainValue *gvalue
,gint power_xy
); gint gwy_grain_value_get_power_z (GwyGrainValue *gvalue
); void gwy_grain_value_set_power_z (GwyGrainValue *gvalue
,gint power_z
); GwyGrainValueFlags gwy_grain_value_get_flags (GwyGrainValue *gvalue
); void gwy_grain_value_set_flags (GwyGrainValue *gvalue
,GwyGrainValueFlags flags
); GwyGrainQuantity gwy_grain_value_get_quantity (GwyGrainValue *gvalue
); const gchar * gwy_grain_value_get_expression (GwyGrainValue *gvalue
); gboolean gwy_grain_value_set_expression (GwyGrainValue *gvalue
,const gchar *expression
,GError **error
); const gchar * gwy_grain_value_group_name (GwyGrainValueGroup group
); GwyInventory * gwy_grain_values (void
); GwyGrainValue * gwy_grain_values_get_grain_value (const gchar *name
); GwyGrainValue * gwy_grain_values_get_builtin_grain_value (GwyGrainQuantity quantity
); void gwy_grain_values_calculate (gint nvalues
,GwyGrainValue **gvalues
,gdouble **results
,GwyDataField *data_field
,gint ngrains
,const gint *grains
);
struct GwyGrainValueClass { GwyResourceClass parent_class; void (*reserved1)(void); void (*reserved2)(void); };
typedef enum { GWY_GRAIN_VALUE_GROUP_ID = 0, GWY_GRAIN_VALUE_GROUP_POSITION, GWY_GRAIN_VALUE_GROUP_VALUE, GWY_GRAIN_VALUE_GROUP_AREA, GWY_GRAIN_VALUE_GROUP_VOLUME, GWY_GRAIN_VALUE_GROUP_BOUNDARY, GWY_GRAIN_VALUE_GROUP_SLOPE, GWY_GRAIN_VALUE_GROUP_CURVATURE, GWY_GRAIN_VALUE_GROUP_USER = 30 } GwyGrainValueGroup;
typedef enum { GWY_GRAIN_VALUE_SAME_UNITS = 1 << 0, GWY_GRAIN_VALUE_IS_ANGLE = 1 << 1 } GwyGrainValueFlags;
Special attributes of grain values.
Certain grain quantities, such as the surface
area or absolute inclination, are only
meaningful if value (height) is the same
physical quantity as lateral dimensions. These
have this flag set to TRUE .
|
|
Angular quantities are internally always
calculated in radians, however they can be
presented in degrees in the user interface.
To enable such special handling, set this
flag to TRUE .
|
Since 2.8
typedef struct { GwyGrainValueGroup group; gchar *symbol_markup; gchar *symbol; gchar *reserveds; gint power_xy; gint power_z; guint flags; gint reservedi; } GwyGrainValueData;
GwyGrainValueGroup gwy_grain_value_get_group (GwyGrainValue *gvalue
);
Gets the group of a grain value.
All user-defined grain values belong to GWY_GRAIN_VALUE_GROUP_USER
group,
built-in grain values belong to other groups.
|
A grain value object. |
Returns : |
The group of gvalue . |
Since 2.8
const gchar * gwy_grain_value_get_symbol (GwyGrainValue *gvalue
);
Gets the plain symbol representing a grain value.
The plain symbol is used in expressions. It has to be a valid identifier and it should be easy to type. (Note currently it is not possible to use user-defined grain quantities in expressions for other user-defined grain quantities.)
|
A grain value object. |
Returns : |
Plain symbol of gvalue , owned by gvalue . |
Since 2.8
void gwy_grain_value_set_symbol (GwyGrainValue *gvalue
,const gchar *symbol
);
Sets the plain symbol representing a grain value.
See gwy_grain_value_get_symbol()
for details.
|
A grain value object. |
|
The new symbol. |
Since 2.8
const gchar * gwy_grain_value_get_symbol_markup (GwyGrainValue *gvalue
);
Gets the rich text symbol representing a grain value.
The returned value can contain Pango markup and is suitable for instance for graph axis labels.
|
A grain value object. |
Returns : |
Rich text symbol of gvalue , owned by gvalue . |
Since 2.8
void gwy_grain_value_set_symbol_markup (GwyGrainValue *gvalue
,const gchar *symbol
);
Sets the rich text symbol representing a grain value.
See gwy_grain_value_get_symbol_markup()
for details.
|
A grain value object. |
|
The new symbol. |
Since 2.8
gint gwy_grain_value_get_power_xy (GwyGrainValue *gvalue
);
Gets the power of lateral dimensions in a grain value.
The units of a grain value are determined as the product of lateral units and value units, raised to certain powers. For instance lengths in the horizontal plane have xy power of 1 and areas have 2, whereas volumes have xy power of 2 and value power of 1.
|
A grain value object. |
Returns : |
The power of lateral dimensions. |
Since 2.8
void gwy_grain_value_set_power_xy (GwyGrainValue *gvalue
,gint power_xy
);
Sets the power of lateral dimensions in a grain value.
|
A grain value object. |
|
The new lateral dimensions power. |
Since 2.8
gint gwy_grain_value_get_power_z (GwyGrainValue *gvalue
);
Gets the power of value (height) in a grain value.
See gwy_grain_value_get_power_xy()
for details.
|
A grain value object. |
Returns : |
The power of value (height). |
Since 2.8
void gwy_grain_value_set_power_z (GwyGrainValue *gvalue
,gint power_z
);
Sets the power of value (height) in a grain value.
|
A grain value object. |
|
The new value (height) power. |
Since 2.8
GwyGrainValueFlags gwy_grain_value_get_flags (GwyGrainValue *gvalue
);
Obtains the special attributes of a grain quantity.
|
A grain value object. |
Returns : |
The special attribute flags set on gvalue . See
GwyGrainValueFlags for their description. |
Since 2.8
void gwy_grain_value_set_flags (GwyGrainValue *gvalue
,GwyGrainValueFlags flags
);
Sets the special attributes of a grain quantity.
The value of flags
determines the complete new set of flags. To set
individual flags, obtain the current set with gwy_grain_value_get_flags()
first and then set/unset individual flags.
|
A grain value object. |
|
The special attributes to set on gvalue . |
Since 2.8
GwyGrainQuantity gwy_grain_value_get_quantity (GwyGrainValue *gvalue
);
Gets the built-in grain quantity corresponding to a grain value.
|
A grain value object. |
Returns : |
The corresponding built-in GwyGrainQuantity if gvalue is a
built-it grain value, -1 if gvalue is an user-defined grain value. |
Since 2.8
const gchar * gwy_grain_value_get_expression (GwyGrainValue *gvalue
);
Gets the expression of a user-defined grain value.
|
A grain value object. |
Returns : |
The expression as a string owned by gvalue , NULL if gvalue
is a built-in grain value. |
Since 2.8
gboolean gwy_grain_value_set_expression (GwyGrainValue *gvalue
,const gchar *expression
,GError **error
);
Sets the expression of a user-defined grain value.
It is an error to call this function on a built-in quantity.
|
A grain value object. |
|
New grain value expression. |
|
Return location for the error, or NULL to ignore errors. |
Returns : |
TRUE if the expression is compilable and references only known
grain quantities. FALSE is the expression is not calculable,
in this case the gvalue 's expression is unchanged. |
Since 2.8
const gchar * gwy_grain_value_group_name (GwyGrainValueGroup group
);
Obtains the name of a grain value group.
|
Grain value group. |
Returns : |
The grain value group name as a constant untranslated string, owned by the library. |
Since 2.8
GwyInventory * gwy_grain_values (void
);
Gets the inventory with all the grain values.
Returns : |
Grain value inventory. |
Since 2.8
GwyGrainValue * gwy_grain_values_get_grain_value (const gchar *name
);
Convenience function to get a grain quantity from gwy_grain_values()
by
name.
|
Grain quantity name. |
Returns : |
Grain quantity identified by name or NULL if there is no such
grain quantity. |
Since 2.8
GwyGrainValue * gwy_grain_values_get_builtin_grain_value
(GwyGrainQuantity quantity
);
Obtains the built-in grain value corresponding to given enum value.
|
A GwyGrainQuantity value. |
Returns : |
The built-in grain value corresponding to quantity , NULL if there
is no such grain value. |
Since 2.8
void gwy_grain_values_calculate (gint nvalues
,GwyGrainValue **gvalues
,gdouble **results
,GwyDataField *data_field
,gint ngrains
,const gint *grains
);
Calculates a set of grain values.
See also gwy_data_field_grains_get_quantities()
for a simplier function
for built-in grain values.
|
Number of items in gvalues . |
|
Array of grain value objects. |
|
Array of length nvalues of arrays of length ngrains +1 of doubles
to put the calculated values to. |
|
Data field used for marking. For some values its values
are not used, but its dimensions determine the dimensions of
grains . |
|
The number of grains as returned by
gwy_data_field_number_grains() . |
|
Grain numbers filled with gwy_data_field_number_grains() . |
Since 2.8