| Gwyddion Data Processing Library Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Signals | ||||
#include <libprocess/gwyprocess.h> struct GwyBrick; struct GwyBrickClass; GwyBrickPart; #define gwy_brick_duplicate (brick) GwyBrick * gwy_brick_new (gint xres,gint yres,gint zres,gdouble xreal,gdouble yreal,gdouble zreal,gboolean nullme); GwyBrick * gwy_brick_new_alike (GwyBrick *model,gboolean nullme); GwyBrick * gwy_brick_new_part (const GwyBrick *brick,gint xpos,gint ypos,gint zpos,gint xres,gint yres,gint zres,gboolean keep_offsets); void gwy_brick_data_changed (GwyBrick *brick); void gwy_brick_resample (GwyBrick *brick,gint xres,gint yres,gint zres,GwyInterpolationType interpolation); gint gwy_brick_get_xres (GwyBrick *brick); gint gwy_brick_get_yres (GwyBrick *brick); gint gwy_brick_get_zres (GwyBrick *brick); gdouble gwy_brick_get_xreal (GwyBrick *brick); gdouble gwy_brick_get_yreal (GwyBrick *brick); gdouble gwy_brick_get_zreal (GwyBrick *brick); gdouble gwy_brick_get_xoffset (GwyBrick *brick); gdouble gwy_brick_get_yoffset (GwyBrick *brick); gdouble gwy_brick_get_zoffset (GwyBrick *brick); const gdouble * gwy_brick_get_data_const (GwyBrick *brick); void gwy_brick_set_xreal (GwyBrick *brick,gdouble xreal); void gwy_brick_set_yreal (GwyBrick *brick,gdouble yreal); void gwy_brick_set_zreal (GwyBrick *brick,gdouble zreal); void gwy_brick_set_xoffset (GwyBrick *brick,gdouble xoffset); void gwy_brick_set_yoffset (GwyBrick *brick,gdouble yoffset); void gwy_brick_set_zoffset (GwyBrick *brick,gdouble zoffset); GwySIUnit * gwy_brick_get_si_unit_x (GwyBrick *brick); GwySIUnit * gwy_brick_get_si_unit_y (GwyBrick *brick); GwySIUnit * gwy_brick_get_si_unit_z (GwyBrick *brick); GwySIUnit * gwy_brick_get_si_unit_w (GwyBrick *brick); void gwy_brick_set_si_unit_x (GwyBrick *brick,GwySIUnit *si_unit); void gwy_brick_set_si_unit_y (GwyBrick *brick,GwySIUnit *si_unit); void gwy_brick_set_si_unit_z (GwyBrick *brick,GwySIUnit *si_unit); void gwy_brick_set_si_unit_w (GwyBrick *brick,GwySIUnit *si_unit); gdouble gwy_brick_get_min (GwyBrick *brick); gdouble gwy_brick_get_max (GwyBrick *brick); GwySIValueFormat * gwy_brick_get_value_format_x (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format); GwySIValueFormat * gwy_brick_get_value_format_y (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format); GwySIValueFormat * gwy_brick_get_value_format_z (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format); GwySIValueFormat * gwy_brick_get_value_format_w (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format); gdouble * gwy_brick_get_data (GwyBrick *brick); gdouble gwy_brick_itor (GwyBrick *brick,gdouble pixpos); gdouble gwy_brick_rtoi (GwyBrick *brick,gdouble realpos); gdouble gwy_brick_jtor (GwyBrick *brick,gdouble pixpos); gdouble gwy_brick_rtoj (GwyBrick *brick,gdouble realpos); gdouble gwy_brick_ktor (GwyBrick *brick,gdouble pixpos); gdouble gwy_brick_rtok (GwyBrick *brick,gdouble realpos); gdouble gwy_brick_get_val (GwyBrick *brick,gint col,gint row,gint lev); void gwy_brick_set_val (GwyBrick *brick,gint col,gint row,gint lev,gdouble value); gdouble gwy_brick_get_val_real (GwyBrick *brick,gdouble x,gdouble y,gdouble z); void gwy_brick_set_val_real (GwyBrick *brick,gdouble x,gdouble y,gdouble z,gdouble value); gdouble gwy_brick_get_dval (GwyBrick *brick,gdouble x,gdouble y,gdouble z,gint interpolation); gdouble gwy_brick_get_dval_real (GwyBrick *brick,gdouble x,gdouble y,gdouble z,gint interpolation); void gwy_brick_clear (GwyBrick *brick); void gwy_brick_fill (GwyBrick *brick,gdouble value); void gwy_brick_multiply (GwyBrick *brick,gdouble value); void gwy_brick_add (GwyBrick *brick,gdouble value); void gwy_brick_extract_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_sum_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_min_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_max_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_minpos_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_maxpos_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_mean_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_rms_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets); void gwy_brick_extract_line (const GwyBrick *brick,GwyDataLine *target,gint istart,gint jstart,gint kstart,gint iend,gint jend,gint kend,gboolean keep_offsets); GwyDataLine * gwy_brick_get_zcalibration (const GwyBrick *brick); void gwy_brick_set_zcalibration (const GwyBrick *brick,GwyDataLine *calibration);
GwyBrick represents 3D data arrays in Gwyddion. It is typically useful for different volume data obtained from SPMs, like in force volume measurements.
struct GwyBrick;
The GwyBrick struct contains private data only and should be accessed using the functions below.
Since 2.31
struct GwyBrickClass {
GObjectClass parent_class;
void (*data_changed)(GwyBrick *brick);
void (*reserved1)(void);
};
typedef struct {
guint col;
guint row;
guint level;
guint width;
guint height;
guint depth;
} GwyBrickPart;
#define gwy_brick_duplicate(brick)
Convenience macro doing gwy_serializable_duplicate() with all the necessary
typecasting.
|
A data brick to duplicate. |
Since 2.31
GwyBrick * gwy_brick_new (gint xres,gint yres,gint zres,gdouble xreal,gdouble yreal,gdouble zreal,gboolean nullme);
Creates a new data brick.
|
X resolution, i.e., the number of samples in x direction |
|
Real physical dimension in x direction. |
|
Real physical dimension in y direction. |
|
Real physical dimension in z direction. |
|
Whether the data brick should be initialized to zeroes. If FALSE,
the data will not be initialized. |
Returns : |
A newly created data brick. |
Since 2.31
GwyBrick * gwy_brick_new_alike (GwyBrick *model,gboolean nullme);
Creates a new data brick similar to an existing one.
Use gwy_brick_duplicate() if you want to copy a data brick including
data.
|
A data brick to take resolutions and units from. |
|
Whether the data brick should be initialized to zeroes. If FALSE,
the data will not be initialized. |
Returns : |
A newly created data brick. |
Since 2.31
GwyBrick * gwy_brick_new_part (const GwyBrick *brick,gint xpos,gint ypos,gint zpos,gint xres,gint yres,gint zres,gboolean keep_offsets);
Creates a new data brick as a part of existing one.
Use gwy_brick_duplicate() if you want to copy a whole data brick.
|
A data brick to take data from |
|
x position where to start from |
|
y position where to start from |
|
z position where to start from |
|
x resolution (width) to be extracted |
|
y resolution (height) to be extracted |
|
z resolution (depth) to be extracted |
|
keep offsets of data during extraction |
Returns : |
A newly created data brick. |
Since 2.32
void gwy_brick_data_changed (GwyBrick *brick);
Emits signal "data_changed" on a data brick.
|
A data brick. |
Since 2.31
void gwy_brick_resample (GwyBrick *brick,gint xres,gint yres,gint zres,GwyInterpolationType interpolation);
Resamples a data brick.
In other words changes the size of three dimensional field related with data brick. The original values are used for resampling using a requested interpolation alorithm.
|
A data brick. |
|
Desired x resolution. |
|
Desired y resolution. |
|
Desired z resolution. |
|
Interpolation method to use. |
Since 2.31
gint gwy_brick_get_xres (GwyBrick *brick);
Gets the x resolution of a data brick.
|
A data brick. |
Returns : |
Resolution (number of data points). |
Since 2.31
gint gwy_brick_get_yres (GwyBrick *brick);
Gets the y resolution of a data brick.
|
A data brick. |
Returns : |
Resolution (number of data points). |
Since 2.31
gint gwy_brick_get_zres (GwyBrick *brick);
Gets the z resolution of a data brick.
|
A data line. |
Returns : |
Resolution (number of data points). |
Since 2.31
gdouble gwy_brick_get_xreal (GwyBrick *brick);
Gets the physical size of a data brick in the x direction.
|
A data brick. |
Returns : |
Real size of a data brick the x direction. |
Since 2.31
gdouble gwy_brick_get_yreal (GwyBrick *brick);
Gets the physical size of a data brick in the y direction.
|
A data brick. |
Returns : |
Real size of a data brick the y direction. |
Since 2.31
gdouble gwy_brick_get_zreal (GwyBrick *brick);
Gets the physical size of a data brick in the z direction.
|
A data brick. |
Returns : |
Real size of a data brick the z direction. |
Since 2.31
gdouble gwy_brick_get_xoffset (GwyBrick *brick);
Gets the offset of data brick origin in x direction.
|
A data brick. |
Returns : |
Offset value. |
Since 2.31
gdouble gwy_brick_get_yoffset (GwyBrick *brick);
Gets the offset of data brick origin in y direction.
|
A data brick. |
Returns : |
Offset value. |
Since 2.31
gdouble gwy_brick_get_zoffset (GwyBrick *brick);
Gets the offset of data brick origin in z direction.
|
A data brick. |
Returns : |
Offset value. |
Since 2.31
const gdouble * gwy_brick_get_data_const (GwyBrick *brick);
Gets the raw data buffer of a data brick, read-only.
The returned buffer is not guaranteed to be valid through whole data
brick life time. Some function may change it, most notably
gwy_brick_resize() and gwy_brick_resample().
Use gwy_brick_get_data() if you want to change the data.
|
A data brick. |
Returns : |
The data as an array of doubles of length gwy_brick_get_res(). |
Since 2.31
void gwy_brick_set_xreal (GwyBrick *brick,gdouble xreal);
Sets the real x dimension of a brick.
|
A data brick. |
|
New real x dimensions value |
Since 2.31
void gwy_brick_set_yreal (GwyBrick *brick,gdouble yreal);
Sets the real y dimension of a brick.
|
A data brick. |
|
New real y dimensions value |
Since 2.31
void gwy_brick_set_zreal (GwyBrick *brick,gdouble zreal);
Sets the real z dimension of a brick.
|
A data brick. |
|
New real z dimensions value |
Since 2.31
void gwy_brick_set_xoffset (GwyBrick *brick,gdouble xoffset);
Sets the offset of a data brick origin in the x direction.
Note offsets don't affect any calculation, nor functions like
gwy_brick_rtoi().
|
A data brick. |
|
New offset value. |
Since 2.31
void gwy_brick_set_yoffset (GwyBrick *brick,gdouble yoffset);
Sets the offset of a data brick origin in the y direction.
Note offsets don't affect any calculation, nor functions like
gwy_brick_rtoi().
|
A data brick. |
|
New offset value. |
Since 2.31
void gwy_brick_set_zoffset (GwyBrick *brick,gdouble zoffset);
Sets the offset of a data brick origin in the z direction.
Note offsets don't affect any calculation, nor functions like
gwy_brick_rtoi().
|
A data brick. |
|
New offset value. |
Since 2.31
GwySIUnit * gwy_brick_get_si_unit_x (GwyBrick *brick);
Returns x direction SI unit of a data brick.
|
A data brick. |
Returns : |
SI unit corresponding to the lateral (X) dimension of the data brick. Its reference count is not incremented. |
Since 2.31
GwySIUnit * gwy_brick_get_si_unit_y (GwyBrick *brick);
Returns y direction SI unit of a data brick.
|
A data brick. |
Returns : |
SI unit corresponding to the lateral (Y) dimension of the data brick. Its reference count is not incremented. |
Since 2.31
GwySIUnit * gwy_brick_get_si_unit_z (GwyBrick *brick);
Returns z direction SI unit of a data brick.
|
A data brick. |
Returns : |
SI unit corresponding to the "height" (Z) dimension of the data brick. Its reference count is not incremented. |
Since 2.31
GwySIUnit * gwy_brick_get_si_unit_w (GwyBrick *brick);
Returns value SI unit of a data brick.
|
A data brick. |
Returns : |
SI unit corresponding to the "value" of the data brick. Its reference count is not incremented. |
Since 2.31
void gwy_brick_set_si_unit_x (GwyBrick *brick,GwySIUnit *si_unit);
Sets the SI unit corresponding to the lateral (X) dimension of a data brick.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
A data brick. |
|
SI unit to be set. |
Since 2.31
void gwy_brick_set_si_unit_y (GwyBrick *brick,GwySIUnit *si_unit);
Sets the SI unit corresponding to the lateral (Y) dimension of a data brick.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
A data brick. |
|
SI unit to be set. |
Since 2.31
void gwy_brick_set_si_unit_z (GwyBrick *brick,GwySIUnit *si_unit);
Sets the SI unit corresponding to the "height" (Z) dimension of a data brick.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
A data brick. |
|
SI unit to be set. |
Since 2.31
void gwy_brick_set_si_unit_w (GwyBrick *brick,GwySIUnit *si_unit);
Sets the SI unit corresponding to the "value" of a data brick.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
A data brick. |
|
SI unit to be set. |
Since 2.31
gdouble gwy_brick_get_min (GwyBrick *brick);
|
A data brick. |
Returns : |
The minimum value within the brick. |
Since 2.31
gdouble gwy_brick_get_max (GwyBrick *brick);
|
A data brick. |
Returns : |
The maximum value within the brick. |
Since 2.31
GwySIValueFormat * gwy_brick_get_value_format_x (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format);
Finds value format good for displaying coordinates of a data brick.
|
A data brick. |
|
Unit format style. |
|
A SI value format to modify, or NULL to allocate a new one. |
Returns : |
The value format. If format is NULL, a newly allocated format
is returned, otherwise (modified) format itself is returned. |
Since 2.31
GwySIValueFormat * gwy_brick_get_value_format_y (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format);
Finds value format good for displaying values of a data brick.
|
A data brick. |
|
Unit format style. |
|
A SI value format to modify, or NULL to allocate a new one. |
Returns : |
The value format. If format is NULL, a newly allocated format
is returned, otherwise (modified) format itself is returned. |
Since 2.31
GwySIValueFormat * gwy_brick_get_value_format_z (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format);
Finds value format good for displaying values of a data brick.
|
A data brick. |
|
Unit format style. |
|
A SI value format to modify, or NULL to allocate a new one. |
Returns : |
The value format. If format is NULL, a newly allocated format
is returned, otherwise (modified) format itself is returned. |
Since 2.31
GwySIValueFormat * gwy_brick_get_value_format_w (GwyBrick *brick,GwySIUnitFormatStyle style,GwySIValueFormat *format);
Finds value format good for displaying values of a data brick.
Note this functions searches for minimum and maximum value in brick,
therefore it's relatively slow.
|
A data brick. |
|
Unit format style. |
|
A SI value format to modify, or NULL to allocate a new one. |
Returns : |
The value format. If format is NULL, a newly allocated format
is returned, otherwise (modified) format itself is returned. |
Since 2.31
gdouble * gwy_brick_get_data (GwyBrick *brick);
Gets the raw data buffer of a data brick.
The returned buffer is not guaranteed to be valid through whole data
brick life time. Some function may change it, most notably
gwy_brick_resize() and gwy_brick_resample().
This function invalidates any cached information, use
gwy_brick_get_data_const() if you are not going to change the data.
|
A data brick. |
Returns : |
The data as an array of doubles of length gwy_brick_get_res(). |
Since 2.31
gdouble gwy_brick_itor (GwyBrick *brick,gdouble pixpos);
Transforms pixel coordinate to real (physical) coordinate in x direction.
That is it maps range [0..x resolution] to range [0..x real-size]. It is not
suitable for conversion of matrix indices to physical coordinates, you
have to use gwy_brick_itor(brick, pixpos + 0.5) for that.
|
A data brick. |
|
Pixel coordinate. |
Returns : |
pixpos in real coordinates. |
Since 2.31
gdouble gwy_brick_rtoi (GwyBrick *brick,gdouble realpos);
Transforms real (physical) coordinate to pixel coordinate in x axis.
That is it maps range [0..x real-size] to range [0..x resolution].
|
A data brick. |
|
Real coordinate. |
Returns : |
realpos in pixel coordinates. |
Since 2.31
gdouble gwy_brick_jtor (GwyBrick *brick,gdouble pixpos);
Transforms pixel coordinate to real (physical) coordinate in y direction.
That is it maps range [0..y resolution] to range [0..y real-size]. It is not
suitable for conversion of matrix indices to physical coordinates, you
have to use gwy_brick_itor(brick, pixpos + 0.5) for that.
|
A data brick. |
|
Pixel coordinate. |
Returns : |
pixpos in real coordinates. |
Since 2.31
gdouble gwy_brick_rtoj (GwyBrick *brick,gdouble realpos);
Transforms real (physical) coordinate to pixel coordinate in y axis.
That is it maps range [0..y real-size] to range [0..y resolution].
|
A data brick. |
|
Real coordinate. |
Returns : |
realpos in pixel coordinates. |
Since 2.31
gdouble gwy_brick_ktor (GwyBrick *brick,gdouble pixpos);
Transforms pixel coordinate to real (physical) coordinate.
That is it maps range [0..z resolution] to range [0..z real-size]. It is not
suitable for conversion of matrix indices to physical coordinates, you
have to use gwy_brick_itor(brick, pixpos + 0.5) for that.
|
A data brick. |
|
Pixel coordinate. |
Returns : |
pixpos in real coordinates. |
Since 2.31
gdouble gwy_brick_rtok (GwyBrick *brick,gdouble realpos);
Transforms real (physical) coordinate to pixel coordinate in z axis.
That is it maps range [0..z real-size] to range [0..z resolution].
|
A data brick. |
|
Real coordinate. |
Returns : |
realpos in pixel coordinates. |
Since 2.31
gdouble gwy_brick_get_val (GwyBrick *brick,gint col,gint row,gint lev);
Gets value at given position in a data brick.
Do not access data with this function inside inner loops, it's slow.
Get raw data buffer with gwy_brick_get_data_const() and access it
directly instead.
|
A data brick. |
|
Position in the brick (column index). |
|
Position in the brick (row index). |
|
Position in the brick (level index). |
Returns : |
Value at given index. |
Since 2.31
void gwy_brick_set_val (GwyBrick *brick,gint col,gint row,gint lev,gdouble value);
Sets value at given position in a data brick.
Do not access data with this function inside inner loops, it's slow.
Get raw data buffer with gwy_brick_get_data_const() and access it
directly instead.
|
A data brick. |
|
Position in the brick (column index). |
|
Position in the brick (row index). |
|
Position in the brick (level index). |
|
value to be set. |
Since 2.31
gdouble gwy_brick_get_val_real (GwyBrick *brick,gdouble x,gdouble y,gdouble z);
Gets value at given position in a data brick, in real coordinates.
Do not access data with this function inside inner loops, it's slow.
Get raw data buffer with gwy_brick_get_data_const() and access it
directly instead.
|
A data brick. |
|
Position in the brick (x direction). |
|
Position in the brick (y direction). |
|
Position in the brick (z direction). |
Returns : |
Value at given index. |
Since 2.31
void gwy_brick_set_val_real (GwyBrick *brick,gdouble x,gdouble y,gdouble z,gdouble value);
Sets value at given position in a data brick.
Do not access data with this function inside inner loops, it's slow.
Get raw data buffer with gwy_brick_get_data_const() and access it
directly instead.
|
A data brick. |
|
Position in the brick (x direction). |
|
Position in the brick (y direction). |
|
Position in the brick (z direction). |
Since 2.31
gdouble gwy_brick_get_dval (GwyBrick *brick,gdouble x,gdouble y,gdouble z,gint interpolation);
Gets interpolated value at arbitrary data brick point indexed by pixel coordinates.
Note pixel values are centered in intervals [i, i+1].
See also gwy_brick_get_dval_real() that does the same, but takes
real coordinates.
|
A data brick. |
|
Position in data brick in range [0, x resolution]. If the value is outside this range, the nearest border value is returned. |
|
Position in data brick in range [0, y resolution]. If the value is outside this range, the nearest border value is returned. |
|
Position in data brick in range [0, z resolution]. If the value is outside this range, the nearest border value is returned. |
|
Interpolation method to use. |
Returns : |
Value interpolated in the data brick. |
Since 2.31
gdouble gwy_brick_get_dval_real (GwyBrick *brick,gdouble x,gdouble y,gdouble z,gint interpolation);
Gets interpolated value at arbitrary data brick point indexed by pixel coordinates.
Note pixel values are centered in intervals [j, j+1].
See also gwy_brick_get_dval() that does the same, but takes
pixel coordinates.
|
A data brick. |
|
Position in data brick in range [0, x resolution]. If the value is outside this range, the nearest border value is returned. |
|
Position in data brick in range [0, y resolution]. If the value is outside this range, the nearest border value is returned. |
|
Position in data brick in range [0, z resolution]. If the value is outside this range, the nearest border value is returned. |
|
Interpolation method to use. |
Returns : |
Value interpolated in the data brick. |
Since 2.31
void gwy_brick_clear (GwyBrick *brick);
Fills a data brick with zeroes.
|
A data brick. |
Since 2.31
void gwy_brick_fill (GwyBrick *brick,gdouble value);
Fills a data brick with specified value.
|
A data brick. |
|
Value to fill data brick with. |
Since 2.31
void gwy_brick_multiply (GwyBrick *brick,gdouble value);
Multiplies all values in a data brick with a specified value.
|
A data brick. |
|
Value to multiply data brick with. |
Since 2.31
void gwy_brick_add (GwyBrick *brick,gdouble value);
Adds a specified value to all values in a data brick.
|
A data brick. |
|
Value to be added. |
Since 2.31
void gwy_brick_extract_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Extract a plane (GwyDataField) from the brick. One value of set (width, height, depth) needs
to be -1, determining the plane orientation.
|
A data brick. |
|
Datafield to be filled by extracted plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of extracted plane. If width is -1, the yz plane will be extracted. |
|
pixel height of extracted plane. If height is -1, the xz plane will be extracted |
|
pixel depth of extacted plane. If depth is -1, the xy plane will be extracted |
|
keep the physical offsets in extracted field. |
Since 2.31
void gwy_brick_sum_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Sums planes in certain direction and extract the result (GwyDataField). One
value of set (width, height, depth) needs to be -1, determining the plane
orientation. In contrast to gwy_brick_extract_plane, the appropriate start
coordinate (e.g. istart if width = -1) is not used for single plane
extraction, but the planes are accumulated in whole range (0..xres for given
example)
|
A data brick. |
|
Datafield to be filled by summed plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.31
void gwy_brick_min_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Finds minima of planes in certain direction and extract the result
(GwyDataField). One value of set (width, height, depth) needs to be -1,
determining the plane orientation. In contrast to gwy_brick_extract_plane,
the appropriate start coordinate (e.g. istart if width = -1) is not used
for single plane extraction, but the planes are accumulated in whole range
(0..xres for given example)
|
A data brick. |
|
Datafield to be filled by the minima plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.32
void gwy_brick_max_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Finds minima of planes in certain direction and extract the result
(GwyDataField). One value of set (width, height, depth) needs to be -1,
determining the plane orientation. In contrast to gwy_brick_extract_plane,
the appropriate start coordinate (e.g. istart if width = -1) is not used
for single plane extraction, but the planes are accumulated in whole range
(0..xres for given example)
|
A data brick. |
|
Datafield to be filled by the maxima plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.32
void gwy_brick_minpos_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Finds minima positions of planes in certain direction and extract the result
(GwyDataField). One value of set (width, height, depth) needs to be -1,
determining the plane orientation. In contrast to gwy_brick_extract_plane,
the appropriate start coordinate (e.g. istart if width = -1) is not used
for single plane extraction, but the planes are accumulated in whole range
(0..xres for given example)
|
A data brick. |
|
Datafield to be filled by the minima positions plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.32
void gwy_brick_maxpos_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Finds maxima positions of planes in certain direction and extract the result
(GwyDataField). One value of set (width, height, depth) needs to be -1,
determining the plane orientation. In contrast to gwy_brick_extract_plane,
the appropriate start coordinate (e.g. istart if width = -1) is not used
for single plane extraction, but the planes are accumulated in whole range
(0..xres for given example)
|
A data brick. |
|
Datafield to be filled by the maxima positions plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.32
void gwy_brick_mean_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Finds mean of planes in certain direction and extract the result
(GwyDataField). One value of set (width, height, depth) needs to be -1,
determining the plane orientation. In contrast to gwy_brick_extract_plane,
the appropriate start coordinate (e.g. istart if width = -1) is not used
for single plane extraction, but the planes are accumulated in whole range
(0..xres for given example)
|
A data brick. |
|
Datafield to be filled by the mean plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.32
void gwy_brick_rms_plane (const GwyBrick *brick,GwyDataField *target,gint istart,gint jstart,gint kstart,gint width,gint height,gint depth,gboolean keep_offsets);
Finds rms of planes in certain direction and extract the result
(GwyDataField). One value of set (width, height, depth) needs to be -1,
determining the plane orientation. In contrast to gwy_brick_extract_plane,
the appropriate start coordinate (e.g. istart if width = -1) is not used
for single plane extraction, but the planes are accumulated in whole range
(0..xres for given example)
|
A data brick. |
|
Datafield to be filled by the rms plane. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
pixel width of summed plane. If width is -1, the yz planes will be
summed. |
|
pixel height of summed plane. If height is -1, the xz planes will
be summed |
|
pixel depth of extacted plane. If depth is -1, the xy planes will
be summed |
|
keep the physical offsets in extracted field. Not implemented. |
Since 2.32
void gwy_brick_extract_line (const GwyBrick *brick,GwyDataLine *target,gint istart,gint jstart,gint kstart,gint iend,gint jend,gint kend,gboolean keep_offsets);
Extract a line (GwyDataField) from the brick. Only line orientations parallel to coordinate axes are supported now, i.e. two of the start coordinates need to be same as end ones.
|
A data brick. |
|
Dataline to be filled by extracted line. It will be resampled if necessary. |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
column where to start (pixel coordinates). |
|
row where to start (pixel coordinates). |
|
level where to start (pixel coordinates). |
|
keep physical offsets in extracted line |
Since 2.31
GwyDataLine * gwy_brick_get_zcalibration (const GwyBrick *brick);
Gets the z-axis non-linear calibration of a data brick.
|
A data brick. |
Returns : |
Z Calibration (non-linear Z-axis values as ordinates). |
Since 2.32
void gwy_brick_set_zcalibration (const GwyBrick *brick,GwyDataLine *calibration);
Sets the z-axis non-linear calibration of a data brick.
|
A data brick. |
|
GwyDataLine pointer with z-axis non-linear calibration of a data brick (values are stored as ordinates). |
Since 2.32
"data-changed" signalvoid user_function (GwyBrick *gwydataline,
gpointer user_data) : Run First
The ::data-changed signal is never emitted by data line itself. It is intended as a means to notify others data line users they should update themselves.
|
The GwyBrick which received the signal. |
|
user data set when the signal handler was connected. |