gwy_line_new()

GwyLine *
gwy_line_new (gint res,
              gdouble real,
              gboolean nullme);

Creates a new data line.

[constructor]

gwy_line_new_alike()

GwyLine *
gwy_line_new_alike (GwyLine *model,
                    gboolean nullme);

Creates a new data line similar to an existing one.

Use gwy_line_duplicate() if you want to copy a data line including data.

gwy_line_copy()

GwyLine *
gwy_line_copy (GwyLine *line);

Create a new data line as a copy of an existing one.

This function is a convenience gwy_serializable_copy() wrapper.

gwy_line_assign()

void
gwy_line_assign (GwyLine *destination,
                 GwyLine *source);

Makes one data line equal to another.

This function is a convenience gwy_serializable_assign() wrapper.

gwy_line_data_changed()

void
gwy_line_data_changed (GwyLine *line);

Emits signal "data_changed" on a data line.

gwy_line_new_resampled()

GwyLine *
gwy_line_new_resampled (GwyLine *line,
                        gint res,
                        GwyInterpolationType interpolation);

Creates a new data line by resampling an existing one.

This method is equivalent to gwy_line_duplicate() followed by gwy_line_resample(), but it is more efficient.

gwy_line_resample()

void
gwy_line_resample (GwyLine *line,
                   gint res,
                   GwyInterpolationType interpolation);

Resamples a data line.

In other words changes the size of one dimensional field related with data line. The original values are used for resampling using a requested interpolation alorithm.

gwy_line_resize()

void
gwy_line_resize (GwyLine *line,
                 gint res);

Resizes a data line to different size, discarding data.

The real size and offset are kept unchanged. The line contents becomes undefined. The function just makes sure line has the correct pixel dimension.

gwy_line_crop()

void
gwy_line_crop (GwyLine *line,
               gint pos,
               gint len);

Crops a data line to a smaller length.

The real size is updated and the offset is reset to zero.

gwy_line_part_extract()

GwyLine *
gwy_line_part_extract (GwyLine *line,
                       gint pos,
                       gint len);

Extracts a part of a data line to a new data line.

gwy_line_copy_data()

void
gwy_line_copy_data (GwyLine *line,
                    GwyLine *target);

Copies the contents of a data line to another already allocated data line of the same size.

Only the data points are copied. To make a data line completely identical to another, including units and change of dimensions, you can use gwy_line_assign().

gwy_line_get_data()

gdouble *
gwy_line_get_data (GwyLine *line);

Gets the raw data buffer of a data line.

The returned buffer is not guaranteed to be valid through whole data line life time. Some function may change it, most notably gwy_line_resize() and gwy_line_resample().

This function invalidates any cached information, use gwy_line_get_data_const() if you are not going to change the data.

gwy_line_get_data_const()

const gdouble *
gwy_line_get_data_const (GwyLine *line);

Gets the raw data buffer of a data line, read-only.

The returned buffer is not guaranteed to be valid through whole data line life time. Some function may change it, most notably gwy_line_resize() and gwy_line_resample().

Use gwy_line_get_data() if you want to change the data.

gwy_line_invalidate()

void
gwy_line_invalidate (GwyLine *line);

Invalidates cached data line stats.

User code should rarely need this macro, as all GwyLine methods do proper invalidation when they change data, as well as gwy_line_get_data() does.

However, if you get raw data with gwy_line_get_data() and then mix direct changes to it with calls to methods like gwy_line_get_max(), you may need to explicitely invalidate cached values to let gwy_line_get_max() know it has to recompute the maximum.

gwy_line_get_res()

gint
gwy_line_get_res (GwyLine *line);

Gets the number of data points in a data line.

gwy_line_get_real()

gdouble
gwy_line_get_real (GwyLine *line);

Gets the physical size of a data line.

gwy_line_set_real()

void
gwy_line_set_real (GwyLine *line,
                   gdouble real);

Sets the real data line size.

gwy_line_get_offset()

gdouble
gwy_line_get_offset (GwyLine *line);

Gets the offset of data line origin.

gwy_line_set_offset()

void
gwy_line_set_offset (GwyLine *line,
                     gdouble offset);

Sets the offset of a data line origin.

Note offsets don't affect any calculation, nor functions like gwy_line_rtoi().

gwy_line_get_dx()

gdouble
gwy_line_get_dx (GwyLine *line);

Gets the sample distance (pixel size) of a data line in real units.

The result is the same as gwy_line_get_real(line)/gwy_line_get_res(line).

gwy_line_get_unit_x()

GwyUnit *
gwy_line_get_unit_x (GwyLine *line);

Returns lateral SI unit of a data line.

The returned object can be modified to change the line x units.

gwy_line_get_unit_y()

GwyUnit *
gwy_line_get_unit_y (GwyLine *line);

Returns value SI unit of a data line.

The returned object can be modified to change the line value units.

gwy_line_get_value_format_x()

GwyValueFormat *
gwy_line_get_value_format_x (GwyLine *line,
                             GwyUnitFormatStyle style,
                             GwyValueFormat *format);

Finds value format good for displaying coordinates of a data line.

gwy_line_get_value_format_y()

GwyValueFormat *
gwy_line_get_value_format_y (GwyLine *line,
                             GwyUnitFormatStyle style,
                             GwyValueFormat *format);

Finds value format good for displaying values of a data line.

Note this functions searches for minimum and maximum value in line , therefore it's relatively slow.

gwy_line_copy_units()

void
gwy_line_copy_units (GwyLine *line,
                     GwyLine *target);

Sets lateral and value units of a data line to match another data line.

gwy_line_itor()

gdouble
gwy_line_itor (GwyLine *line,
               gdouble pixpos);

Transforms pixel coordinate to real (physical) coordinate.

That is it maps range [0..resolution] to range [0..real-size]. It is not suitable for conversion of matrix indices to physical coordinates, you have to use gwy_line_itor(line , pixpos + 0.5) for that.

gwy_line_rtoi()

gdouble
gwy_line_rtoi (GwyLine *line,
               gdouble realpos);

Transforms real (physical) coordinate to pixel coordinate.

That is it maps range [0..real-size] to range [0..resolution].

gwy_line_get_val()

gdouble
gwy_line_get_val (GwyLine *line,
                  gint i);

Gets value at given position in a data line.

Do not access data with this function inside inner loops, it's slow. Get raw data buffer with gwy_line_get_data_const() and access it directly instead.

gwy_line_set_val()

void
gwy_line_set_val (GwyLine *line,
                  gint i,
                  gdouble value);

Sets the value at given position in a data line.

Do not set data with this function inside inner loops, it's slow. Get raw data buffer with gwy_line_get_data() and write to it directly instead.

gwy_line_get_dval()

gdouble
gwy_line_get_dval (GwyLine *line,
                   gdouble x,
                   GwyInterpolationType interpolation);

Gets interpolated value at arbitrary data line point indexed by pixel coordinates.

Note pixel values are centered in intervals [j , j +1], so to get the same value as gwy_line_get_val(line , j ) returns, it's necessary to add 0.5: gwy_line_get_dval(line , * j +0.5, interpolation ).

See also gwy_line_get_dval_real() that does the same, but takes real coordinates.

gwy_line_get_dval_real()

gdouble
gwy_line_get_dval_real (GwyLine *line,
                        gdouble x,
                        GwyInterpolationType interpolation);

Gets interpolated value at arbitrary data line point indexed by real coordinates.

See also gwy_line_get_dval() for interpolation explanation.

gwy_line_flip()

void
gwy_line_flip (GwyLine *line);

Reflects a data line in place.

gwy_line_invert_value()

void
gwy_line_invert_value (GwyLine *line);

Inverts a data line data in place.

Values are inverted about the mean value. Use gwy_line_multiply() to change the signs of all values.

gwy_line_clear()

void
gwy_line_clear (GwyLine *line);

Fills a data line with zeroes.

gwy_line_fill()

void
gwy_line_fill (GwyLine *line,
               gdouble value);

Fills a data line with specified value.

gwy_line_multiply()

void
gwy_line_multiply (GwyLine *line,
                   gdouble value);

Multiplies all values in a data line with a specified value.

gwy_line_add()

void
gwy_line_add (GwyLine *line,
              gdouble value);

Adds a specified value to all values in a data line.

gwy_line_part_clear()

void
gwy_line_part_clear (GwyLine *line,
                     gint pos,
                     gint len);

Fills a data line part with zeroes.

gwy_line_part_fill()

void
gwy_line_part_fill (GwyLine *line,
                    gint pos,
                    gint len,
                    gdouble value);

Fills specified part of data line with specified number

gwy_line_part_multiply()

void
gwy_line_part_multiply (GwyLine *line,
                        gint pos,
                        gint len,
                        gdouble value);

Multiplies all values in a part of data line by specified value.

gwy_line_part_add()

void
gwy_line_part_add (GwyLine *line,
                   gint pos,
                   gint len,
                   gdouble value);

Adds specified value to all values in a part of a data line.

gwy_line_threshold()

gint
gwy_line_threshold (GwyLine *line,
                    gdouble threshval,
                    gdouble bottom,
                    gdouble top);

Sets all the values to bottom or top value depending on whether the original values are below or above threshold value

gwy_line_part_threshold()

gint
gwy_line_part_threshold (GwyLine *line,
                         gint pos,
                         gint len,
                         gdouble threshval,
                         gdouble bottom,
                         gdouble top);

Sets all the values within interval to bottom or top value depending on whether the original values are below or above threshold value.

gwy_line_get_der()

gdouble
gwy_line_get_der (GwyLine *line,
                  gint i);

Computes central derivaltion at given index in a data line.

gwy_line_cumulate()

void
gwy_line_cumulate (GwyLine *line,
                   gboolean transform_to_cdist);

Transforms a distribution in a data line to cummulative distribution.

Each element becomes sum of all previous elements in the line, including self. If transform_to_cdist is FALSE, this is the only change.

If it is TRUE, the values are also multiplied by gwy_line_dx() and the y-unit is multiplied by the x-unit, corresponding to integration. In addition, the tail is forced to not exceed 1 and the last value is forced to be exactly 1 (working around possible rounding errors). This is useful when line is normalised as a probability distribution function and it should be fully transformed to a cummulative distribution function.

See also gwy_accumulate_counts().

gwy_line_filter_slope()

void
gwy_line_filter_slope (GwyLine *line,
                       GwyLine *der);

gwy_line_sqrt()

void
gwy_line_sqrt (GwyLine *line);

Applies sqrt() to each element in a data line.

struct GwyLine

struct GwyLine;

struct GwyLineClass

struct GwyLineClass {
    GObjectClass parent_class;

    void (*data_changed)(GwyLine *line);
};

The “data-changed” signal

void
user_function (GwyLine *gwyline,
               gpointer user_data)

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.

Flags: Run First