Top | ![]() |
![]() |
![]() |
![]() |
const gchar * | gwy_tip_model_get_group_name () |
gint | gwy_tip_model_get_nparams () |
const GwyTipParamType * | gwy_tip_model_get_params () |
void | gwy_tip_model_create () |
void | gwy_tip_model_create_for_zrange () |
GwyInventory * | gwy_tip_models () |
The follwing tip shapes are defined:
"Pyramid" – general pyramid with an arbitrary number of sides |
"Contact" – four-sided pyramid with atan(√2) side slope |
"Non-contact" – three-sided pyramid with 70° side slope |
"Delta function" – single pixel tip |
"Parabola" – parabolic tip |
"Cone" – conical tip |
"Elliptical parabola" – asymmetrical parabolic typ |
"Ball on stick" – spherical tip at the end of almost-cyliner |
The delta-function tip is a single pixel, but usually in a 3×3 or even larger tip image. Therefore, it may or may behave as infinitely sharp, depending on the height.
const gchar *
gwy_tip_model_get_group_name (GwyTipModel *model
);
Gets group name of of a tip model.
Model names, such as "Analytical" or "Pyramid", are informative.
gint
gwy_tip_model_get_nparams (GwyTipModel *model
);
Get number of tip model parameters.
The parameters are from a predefined set enumerated in GwyTipParamType. Use gwy_tip_model_get_params()
to get
the parameter list.
const GwyTipParamType *
gwy_tip_model_get_params (GwyTipModel *model
);
Gets the list of parameters of a tip model.
All tip models have parameters from a predefined set given by the GwyTipParamType enum. Use
gwy_tip_model_get_nparams()
to get the number of parameters.
Note that further items may be in principle added to the enum in the future so you may want to avoid tip models that have parameters with an unknown (higher than known) id.
void gwy_tip_model_create (GwyTipModel *model
,GwyDataField *tip
,const gdouble *params
);
Fills a data field with a model tip model.
Both pixel and physical dimensions of tip
are preserved by this function. Ensure that before using this function
tip
has the same physical pixel size as target data field you want to use the tip model with.
The number of parameters is the true full number of parameters as reported by gwy_tip_model_get_nparams()
and
gwy_tip_model_get_params()
. Exacly these parameters are passed in params
, in the reported order.
void gwy_tip_model_create_for_zrange (GwyTipModel *model
,GwyDataField *tip
,gdouble zrange
,gboolean square
,const gdouble *params
);
Fills a data field with a model tip model, resizing it to make it suitable for the given value range.
The physical dimensions of a pixel in tip
is preserved by this function. Ensure that before using this function
the tip
data field has the same pixel size as target data field you want to use the tip model with.
However, its dimensions (xres
and yres
) will generally be changed to ensure it is optimal for zrange
. This
means it is guaranteed the height difference between the apex and any border pixel in tip
is at least zrange
,
while simultaneously the smallest such difference is not much larger than zrange
.
The number of parameters is the true full number of parameters as reported by gwy_tip_model_get_nparams()
and
gwy_tip_model_get_params()
. Exacly these parameters are passed in params
, in the reported order.
GwyInventory *
gwy_tip_models (void
);
Gets inventory with all the predefined tip models.
Type of tip model parameter.
This enum is used with the new tip model functions gwy_tip_model_get_params()
,
gwy_tip_model_create()
, gwy_tip_model_create_for_zrange()
.
Total tip height. This is used only in the delta function tip; for all others it is implied. |
||
Radius of curvature of the tip apex. |
||
Rotation angle. |
||
Number of sides for pyramidal tips. |
||
Half-angle of the apex (complement of the side slope for straight sides). A small angle means a sharp tip. |
||
Ratio between larger and smaller tip width in two orthotonal directions. |