GwyCalibration

GwyCalibration — Resource for managing calibrations

Synopsis

#include <libprocess/gwyprocess.h>

struct              GwyCalibration;
struct              GwyCalibrationClass;
GwyCalibration *    gwy_calibration_new                 (const gchar *name,
                                                         const char *filename);
const gchar *       gwy_calibration_get_filename        (GwyCalibration *calibration);
gint                gwy_calibration_get_ndata           (GwyCalibration *calibration);
GwyInventory *      gwy_calibrations                    (void);
GwyCalibration *    gwy_calibrations_get_calibration    (const gchar *name);
GwyCalData *        gwy_calibration_get_data            (GwyCalibration *calibration);

Object Hierarchy

  GObject
   +----GwyResource
         +----GwyCalibration

Description

GwyCalibration is a resource used for managing calibration data. These resources are stored separately from calibration data and contain namely filename of connected calibration data file.

Details

struct GwyCalibration

struct GwyCalibration;

The GwyCalibration struct contains private data only and should be accessed using the functions below.

Since 2.23


struct GwyCalibrationClass

struct GwyCalibrationClass {
    GwyResourceClass parent_class;

    void (*reserved1)(void);
    void (*reserved2)(void);
};


gwy_calibration_new ()

GwyCalibration *    gwy_calibration_new                 (const gchar *name,
                                                         const char *filename);

Creates new calibration resource.

name :

Name of resource

filename :

Filename of associated calibration data

Returns :

A newly created calibration resource.

Since 2.23


gwy_calibration_get_filename ()

const gchar *       gwy_calibration_get_filename        (GwyCalibration *calibration);

Get filename of associated calibration data.

calibration :

Calibration resource

Returns :

Filename of associated calibration data.

Since 2.23


gwy_calibration_get_ndata ()

gint                gwy_calibration_get_ndata           (GwyCalibration *calibration);


gwy_calibrations ()

GwyInventory *      gwy_calibrations                    (void);

Gets inventory with all the calibrations.

Returns :

Calibration inventory.

Since 2.23


gwy_calibrations_get_calibration ()

GwyCalibration *    gwy_calibrations_get_calibration    (const gchar *name);

Convenience function to get a calibration from gwy_calibrations() by name.

name :

Calibration name. May be NULL to get the default calibration.

Returns :

Calibration identified by name or the default calibration if name does not exist.

Since 2.23


gwy_calibration_get_data ()

GwyCalData *        gwy_calibration_get_data            (GwyCalibration *calibration);

Obtains the data related to calibration.

calibration :

A calibration.

Returns :

The data related to calibration.

Since 2.23