synth: Gwyddion Data Processing Library Reference Manual

## synth synth — Synthetic data generation |

## Functions

void | gwy_data_field_synth_gaussian_displacement ()

## Includes

    #include <libprocess/gwyprocess.h>

## Description

## Functions

### gwy_data_field_synth_gaussian_displacement ()

    void
    gwy_data_field_synth_gaussian_displacement
                                   (GwyDataField *data_field,
                                    gdouble sigma,
                                    gdouble tau,
                                    GRand *rng);

Fills a data field with correlated Gaussian noise, suitable as displacement field.

The number of calls to `rng` is unspecified; it will not be left in any defined state. However, the noise is filled from the data field centre. Meaning that changing `tau` will zoom in or out the Gaussian noise, preserving the centr (whereas changing `sigma` simply changes the amplitude).

#### Parameters

data_field | A data field. |
sigma | Amplitude of displacement (in units of 1, usually meaning pixels). |
tau | Lateral scale of displacement variation (in pixels). |
rng | Random number generator. |

Since: 2.59