File: surface.h

package info (click to toggle)
gwyddion 2.67-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 54,152 kB
  • sloc: ansic: 412,023; python: 7,885; sh: 5,492; makefile: 4,957; xml: 3,954; cpp: 2,107; pascal: 418; perl: 154; ruby: 130
file content (143 lines) | stat: -rw-r--r-- 8,206 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 *  $Id: surface.h 25820 2023-10-11 08:51:59Z yeti-dn $
 *  Copyright (C) 2011-2022 David Necas (Yeti).
 *  E-mail: yeti@gwyddion.net.
 *
 *  This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
 *  License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any
 *  later version.
 *
 *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 *  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 *  details.
 *
 *  You should have received a copy of the GNU General Public License along with this program; if not, write to the
 *  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef __GWY_SURFACE_H__
#define __GWY_SURFACE_H__

#include <libgwyddion/gwyserializable.h>
#include <libgwyddion/gwymath.h>
#include <libprocess/gwyprocessenums.h>
#include <libprocess/datafield.h>

G_BEGIN_DECLS

#define GWY_TYPE_SURFACE            (gwy_surface_get_type())
#define GWY_SURFACE(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), GWY_TYPE_SURFACE, GwySurface))
#define GWY_SURFACE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), GWY_TYPE_SURFACE, GwySurfaceClass))
#define GWY_IS_SURFACE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), GWY_TYPE_SURFACE))
#define GWY_IS_SURFACE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GWY_TYPE_SURFACE))
#define GWY_SURFACE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), GWY_TYPE_SURFACE, GwySurfaceClass))

typedef struct _GwySurface      GwySurface;
typedef struct _GwySurfaceClass GwySurfaceClass;

struct _GwySurface {
    GObject g_object;
    struct _GwySurfacePrivate *priv;
    /*<public>*/
    guint n;
    GwyXYZ *data;
};

struct _GwySurfaceClass {
    GObjectClass g_object_class;

    void (*data_changed)(GwySurface *surface);
    /*< private >*/
    void (*reserved1)(void);
};

#define gwy_surface_duplicate(surface) \
        (GWY_SURFACE(gwy_serializable_duplicate(G_OBJECT(surface))))
#define gwy_surface_assign(dest, source) \
        gwy_serializable_clone_with_type(G_OBJECT(source), G_OBJECT(dest), GWY_TYPE_SURFACE)
#ifndef GWY_DISABLE_DEPRECATED
#define gwy_surface_clone(dest, src) (gwy_serializable_clone(G_OBJECT(dest), G_OBJECT(src)))
#endif

GType             gwy_surface_get_type                (void)                       G_GNUC_CONST;
GwySurface*       gwy_surface_new                     (void);
GwySurface*       gwy_surface_new_sized               (guint n);
GwySurface*       gwy_surface_new_from_data           (const GwyXYZ *points,
                                                       guint n);
GwySurface*       gwy_surface_new_alike               (GwySurface *model);
GwySurface*       gwy_surface_new_part                (GwySurface *surface,
                                                       gdouble xfrom,
                                                       gdouble xto,
                                                       gdouble yfrom,
                                                       gdouble yto);
GwyXYZ*           gwy_surface_get_data                (GwySurface *surface);
const GwyXYZ*     gwy_surface_get_data_const          (GwySurface *surface);
guint             gwy_surface_get_npoints             (GwySurface *surface);
void              gwy_surface_data_changed            (GwySurface *surface);
void              gwy_surface_copy                    (GwySurface *src,
                                                       GwySurface *dest);
void              gwy_surface_invalidate              (GwySurface *surface);
void              gwy_surface_set_from_data_field     (GwySurface *surface,
                                                       GwyDataField *data_field);
void              gwy_surface_set_from_data_field_mask(GwySurface *surface,
                                                       GwyDataField *data_field,
                                                       GwyDataField *mask,
                                                       GwyMaskingType masking);
GwySIUnit*        gwy_surface_get_si_unit_xy          (GwySurface *surface);
GwySIUnit*        gwy_surface_get_si_unit_z           (GwySurface *surface);
void              gwy_surface_set_si_unit_xy          (GwySurface *surface,
                                                       GwySIUnit *si_unit);
void              gwy_surface_set_si_unit_z           (GwySurface *surface,
                                                       GwySIUnit *si_unit);
GwySIValueFormat* gwy_surface_get_value_format_xy     (GwySurface *surface,
                                                       GwySIUnitFormatStyle style,
                                                       GwySIValueFormat *format);
GwySIValueFormat* gwy_surface_get_value_format_z      (GwySurface *surface,
                                                       GwySIUnitFormatStyle style,
                                                       GwySIValueFormat *format);
void              gwy_surface_copy_units              (GwySurface *surface,
                                                       GwySurface *target);
void              gwy_data_field_copy_units_to_surface(GwyDataField *data_field,
                                                       GwySurface *surface);
void              gwy_surface_copy_units_to_data_field(GwySurface *surface,
                                                       GwyDataField *data_field);
GwyXYZ            gwy_surface_get                     (GwySurface *surface,
                                                       guint pos);
void              gwy_surface_set                     (GwySurface *surface,
                                                       guint pos,
                                                       GwyXYZ point);
void              gwy_surface_get_xrange              (GwySurface *surface,
                                                       gdouble *min,
                                                       gdouble *max);
void              gwy_surface_get_yrange              (GwySurface *surface,
                                                       gdouble *min,
                                                       gdouble *max);
void              gwy_surface_get_min_max             (GwySurface *surface,
                                                       gdouble *min,
                                                       gdouble *max);
void              gwy_surface_multiply                (GwySurface *surface,
                                                       gdouble value);
void              gwy_surface_add                     (GwySurface *surface,
                                                       gdouble value);
void              gwy_surface_scale_xy                (GwySurface *surface,
                                                       gdouble xfactor,
                                                       gdouble yfactor,
                                                       gdouble xoffset,
                                                       gdouble yoffset);
const GwyXYZ*     gwy_surface_get_data_full           (GwySurface *surface,
                                                       guint *n);
void              gwy_surface_set_data_full           (GwySurface *surface,
                                                       const GwyXYZ *points,
                                                       guint n);
gboolean          gwy_surface_xy_is_compatible        (GwySurface *surface,
                                                       GwySurface *othersurface);
GwySurface*       gwy_surface_reduce_points           (GwySurface *surface,
                                                       guint npoints);
void              gwy_surface_resize                  (GwySurface *surface,
                                                       guint npoints);

G_END_DECLS

#endif

/* vim: set cin columns=120 tw=118 et ts=4 sw=4 cino=>1s,e0,n0,f0,{0,}0,^0,\:1s,=0,g1s,h0,t0,+1s,c3,(0,u0 : */