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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwySurface: Gwyddion Data Processing Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="prev" href="GwyBrick.html" title="GwyBrick">
<link rel="next" href="GwyCalibration.html" title="GwyCalibration">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GwySurface.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GwySurface.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GwySurface.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GwySurface.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="GwyBrick.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyCalibration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwySurface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwySurface.top_of_page"></a>GwySurface</span></h2>
<p>GwySurface — General two-dimensional data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GwySurface.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-duplicate" title="gwy_surface_duplicate()">gwy_surface_duplicate</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-assign" title="gwy_surface_assign()">gwy_surface_assign</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-clone" title="gwy_surface_clone()">gwy_surface_clone</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-new" title="gwy_surface_new ()">gwy_surface_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-new-sized" title="gwy_surface_new_sized ()">gwy_surface_new_sized</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-new-from-data" title="gwy_surface_new_from_data ()">gwy_surface_new_from_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-new-alike" title="gwy_surface_new_alike ()">gwy_surface_new_alike</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-new-part" title="gwy_surface_new_part ()">gwy_surface_new_part</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-data" title="gwy_surface_get_data ()">gwy_surface_get_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-data-const" title="gwy_surface_get_data_const ()">gwy_surface_get_data_const</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-npoints" title="gwy_surface_get_npoints ()">gwy_surface_get_npoints</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-data-changed" title="gwy_surface_data_changed ()">gwy_surface_data_changed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-copy" title="gwy_surface_copy ()">gwy_surface_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-invalidate" title="gwy_surface_invalidate ()">gwy_surface_invalidate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-set-from-data-field" title="gwy_surface_set_from_data_field ()">gwy_surface_set_from_data_field</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-set-from-data-field-mask" title="gwy_surface_set_from_data_field_mask ()">gwy_surface_set_from_data_field_mask</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../GwySIUnit.html#GwySIUnit-struct"><span class="returnvalue">GwySIUnit</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-si-unit-xy" title="gwy_surface_get_si_unit_xy ()">gwy_surface_get_si_unit_xy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../GwySIUnit.html#GwySIUnit-struct"><span class="returnvalue">GwySIUnit</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-si-unit-z" title="gwy_surface_get_si_unit_z ()">gwy_surface_get_si_unit_z</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-set-si-unit-xy" title="gwy_surface_set_si_unit_xy ()">gwy_surface_set_si_unit_xy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-set-si-unit-z" title="gwy_surface_set_si_unit_z ()">gwy_surface_set_si_unit_z</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../libgwyddion-GwySIValueFormat.html#GwySIValueFormat"><span class="returnvalue">GwySIValueFormat</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-value-format-xy" title="gwy_surface_get_value_format_xy ()">gwy_surface_get_value_format_xy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../libgwyddion-GwySIValueFormat.html#GwySIValueFormat"><span class="returnvalue">GwySIValueFormat</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-value-format-z" title="gwy_surface_get_value_format_z ()">gwy_surface_get_value_format_z</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-copy-units" title="gwy_surface_copy_units ()">gwy_surface_copy_units</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-data-field-copy-units-to-surface" title="gwy_data_field_copy_units_to_surface ()">gwy_data_field_copy_units_to_surface</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-copy-units-to-data-field" title="gwy_surface_copy_units_to_data_field ()">gwy_surface_copy_units_to_data_field</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get" title="gwy_surface_get ()">gwy_surface_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-set" title="gwy_surface_set ()">gwy_surface_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-xrange" title="gwy_surface_get_xrange ()">gwy_surface_get_xrange</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-yrange" title="gwy_surface_get_yrange ()">gwy_surface_get_yrange</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-min-max" title="gwy_surface_get_min_max ()">gwy_surface_get_min_max</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-get-data-full" title="gwy_surface_get_data_full ()">gwy_surface_get_data_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-set-data-full" title="gwy_surface_set_data_full ()">gwy_surface_set_data_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-xy-is-compatible" title="gwy_surface_xy_is_compatible ()">gwy_surface_xy_is_compatible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwySurface.html#gwy-surface-reduce-points" title="gwy_surface_reduce_points ()">gwy_surface_reduce_points</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySurface.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GwySurface.html#GwySurface-data-changed" title="The “data-changed” signal">data-changed</a></td>
<td class="signal_flags"><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySurface.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GwySurface.html#GwySurface-struct" title="struct GwySurface">GwySurface</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GwySurface.html#GwySurfaceClass" title="struct GwySurfaceClass">GwySurfaceClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySurface.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GwySurface
</pre>
</div>
<div class="refsect1">
<a name="GwySurface.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GwySurface implements
<a href="../GwySerializable.html#GwySerializable-struct">GwySerializable</a>.</p>
</div>
<div class="refsect1">
<a name="GwySurface.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libprocess/gwyprocess.h>
</pre>
</div>
<div class="refsect1">
<a name="GwySurface.description"></a><h2>Description</h2>
<p><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> represents general, i.e. possibly unevenly spaced,
two-dimensional data, also called XYZ data.</p>
<p>Surface points are stored in a flat array <a class="link" href="GwySurface.html#GwySurface-struct.data"><span class="type">GwySurface-struct.data</span></a> of <a href="../libgwyddion-Math.html#GwyXYZ"><span class="type">GwyXYZ</span></a>
values.</p>
<p>Unlike <a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a>, a surface can also be empty, i.e. contain zero points.</p>
</div>
<div class="refsect1">
<a name="GwySurface.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gwy-surface-duplicate"></a><h3>gwy_surface_duplicate()</h3>
<pre class="programlisting">#define gwy_surface_duplicate(surface)</pre>
<p>Duplicates a surface.</p>
<p>This is a convenience wrapper of <a href="../GwySerializable.html#gwy-serializable-duplicate"><code class="function">gwy_serializable_duplicate()</code></a>.</p>
<div class="refsect3">
<a name="gwy-surface-duplicate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-assign"></a><h3>gwy_surface_assign()</h3>
<pre class="programlisting">#define gwy_surface_assign(dest, source)</pre>
<p>Convenience macro making one data surface identical to another.</p>
<p>This is just a <a href="../GwySerializable.html#gwy-serializable-clone"><code class="function">gwy_serializable_clone()</code></a> wrapper with all the necessary
typecasting.</p>
<div class="refsect3">
<a name="gwy-surface-assign.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>Target data surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>Source data surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-52.html#api-index-2.52">2.52</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-clone"></a><h3>gwy_surface_clone()</h3>
<pre class="programlisting">#define gwy_surface_clone(dest, src)</pre>
<div class="warning"><p><code class="literal">gwy_surface_clone</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Copies the value of a surface.</p>
<p>This is a convenience wrapper of <a href="../GwySerializable.html#gwy-serializable-clone"><code class="function">gwy_serializable_clone()</code></a>.</p>
<p>Use <a class="link" href="GwySurface.html#gwy-surface-assign" title="gwy_surface_assign()"><code class="function">gwy_surface_assign()</code></a> instead for consistency. Note that the argument
order is reversed!</p>
<div class="refsect3">
<a name="gwy-surface-clone.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>Destination surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src</p></td>
<td class="parameter_description"><p>Source surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-new"></a><h3>gwy_surface_new ()</h3>
<pre class="programlisting"><a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
gwy_surface_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new empty surface.</p>
<p>The surface will not contain any points. This parameterless constructor
exists mainly for language bindings, <a class="link" href="GwySurface.html#gwy-surface-new-from-data" title="gwy_surface_new_from_data ()"><code class="function">gwy_surface_new_from_data()</code></a> is usually
more useful.</p>
<div class="refsect3">
<a name="gwy-surface-new.returns"></a><h4>Returns</h4>
<p> A new empty surface.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-new-sized"></a><h3>gwy_surface_new_sized ()</h3>
<pre class="programlisting"><a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
gwy_surface_new_sized (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
<p>Creates a new surface with preallocated size.</p>
<p>The surface will contain the speficied number of points with uninitialised
values.</p>
<div class="refsect3">
<a name="gwy-surface-new-sized.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Number of points.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-new-sized.returns"></a><h4>Returns</h4>
<p> A new surface.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-new-from-data"></a><h3>gwy_surface_new_from_data ()</h3>
<pre class="programlisting"><a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
gwy_surface_new_from_data (<em class="parameter"><code>const <a href="../libgwyddion-Math.html#GwyXYZ"><span class="type">GwyXYZ</span></a> *points</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
<p>Creates a new surface, filling it with provided points.</p>
<div class="refsect3">
<a name="gwy-surface-new-from-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>points</p></td>
<td class="parameter_description"><p>Array of <em class="parameter"><code>n</code></em>
points with the surface data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Number of points.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-new-from-data.returns"></a><h4>Returns</h4>
<p> A new surface.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-new-alike"></a><h3>gwy_surface_new_alike ()</h3>
<pre class="programlisting"><a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
gwy_surface_new_alike (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *model</code></em>);</pre>
<p>Creates a new empty surface similar to another surface.</p>
<p>The units of the new surface will be identical to those of <em class="parameter"><code>model</code></em>
but the
new surface will not contain any points. Use <a class="link" href="GwySurface.html#gwy-surface-duplicate" title="gwy_surface_duplicate()"><code class="function">gwy_surface_duplicate()</code></a> to
completely duplicate a surface including data.</p>
<div class="refsect3">
<a name="gwy-surface-new-alike.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>A surface to use as the template.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-new-alike.returns"></a><h4>Returns</h4>
<p> A new empty surface.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-new-part"></a><h3>gwy_surface_new_part ()</h3>
<pre class="programlisting"><a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
gwy_surface_new_part (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> xfrom</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> xto</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> yfrom</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> yto</code></em>);</pre>
<p>Creates a new surface as a part of another surface.</p>
<p>The new surface consits of data with lateral coordinates within the
specified ranges (inclusively). It may be empty.</p>
<p>Data are physically copied, i.e. changing the new surface data does not
change <em class="parameter"><code>surface</code></em>
's data and vice versa.</p>
<div class="refsect3">
<a name="gwy-surface-new-part.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xfrom</p></td>
<td class="parameter_description"><p>Minimum x-coordinate value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xto</p></td>
<td class="parameter_description"><p>Maximum x-coordinate value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>yfrom</p></td>
<td class="parameter_description"><p>Minimum y-coordinate value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>yto</p></td>
<td class="parameter_description"><p>Maximum y-coordinate value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-new-part.returns"></a><h4>Returns</h4>
<p> A new surface.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-data"></a><h3>gwy_surface_get_data ()</h3>
<pre class="programlisting"><a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a> *
gwy_surface_get_data (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Gets the raw XYZ data array of a surface.</p>
<p>The returned buffer is not guaranteed to be valid through whole data
surface life time.</p>
<p>This function invalidates any cached information, use
<a class="link" href="GwySurface.html#gwy-surface-get-data-const" title="gwy_surface_get_data_const ()"><code class="function">gwy_surface_get_data_const()</code></a> if you are not going to change the data.</p>
<p>See <a class="link" href="GwySurface.html#gwy-surface-invalidate" title="gwy_surface_invalidate ()"><code class="function">gwy_surface_invalidate()</code></a> for some discussion.</p>
<div class="refsect3">
<a name="gwy-surface-get-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-data.returns"></a><h4>Returns</h4>
<p> The surface XYZ data as a pointer to an array of
<a class="link" href="GwySurface.html#gwy-surface-get-npoints" title="gwy_surface_get_npoints ()"><code class="function">gwy_surface_get_npoints()</code></a> items.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-data-const"></a><h3>gwy_surface_get_data_const ()</h3>
<pre class="programlisting">const <a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a> *
gwy_surface_get_data_const (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Gets the raw XYZ data array of a surface, read-only.</p>
<p>The returned buffer is not guaranteed to be valid through whole data
field life time.</p>
<p>Use <a class="link" href="GwySurface.html#gwy-surface-get-data" title="gwy_surface_get_data ()"><code class="function">gwy_surface_get_data()</code></a> if you want to change the data.</p>
<p>See <a class="link" href="GwySurface.html#gwy-surface-invalidate" title="gwy_surface_invalidate ()"><code class="function">gwy_surface_invalidate()</code></a> for some discussion.</p>
<div class="refsect3">
<a name="gwy-surface-get-data-const.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-data-const.returns"></a><h4>Returns</h4>
<p> The surface XYZ data as a pointer to an array of
<a class="link" href="GwySurface.html#gwy-surface-get-npoints" title="gwy_surface_get_npoints ()"><code class="function">gwy_surface_get_npoints()</code></a> items.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-npoints"></a><h3>gwy_surface_get_npoints ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gwy_surface_get_npoints (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Gets the number of points in an XYZ surface.</p>
<div class="refsect3">
<a name="gwy-surface-get-npoints.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-npoints.returns"></a><h4>Returns</h4>
<p> The number of points.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-data-changed"></a><h3>gwy_surface_data_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_data_changed (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Emits signal GwySurface::data-changed on a surface.</p>
<div class="refsect3">
<a name="gwy-surface-data-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-copy"></a><h3>gwy_surface_copy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_copy (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *src</code></em>,
<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *dest</code></em>);</pre>
<p>Copies the data of a surface to another surface of the same dimensions.</p>
<p>Only the data points are copied. To make a surface completely identical to
another, including units and change of dimensions, you can use
<a class="link" href="GwySurface.html#gwy-surface-clone" title="gwy_surface_clone()"><code class="function">gwy_surface_clone()</code></a>.</p>
<div class="refsect3">
<a name="gwy-surface-copy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>src</p></td>
<td class="parameter_description"><p>Source surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>Destination surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-invalidate"></a><h3>gwy_surface_invalidate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_invalidate (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Invalidates cached surface statistics.</p>
<p>Cached statistics include ranges returned by <a class="link" href="GwySurface.html#gwy-surface-get-xrange" title="gwy_surface_get_xrange ()"><code class="function">gwy_surface_get_xrange()</code></a>,
<a class="link" href="GwySurface.html#gwy-surface-get-yrange" title="gwy_surface_get_yrange ()"><code class="function">gwy_surface_get_yrange()</code></a> and <a class="link" href="GwySurface.html#gwy-surface-get-min-max" title="gwy_surface_get_min_max ()"><code class="function">gwy_surface_get_min_max()</code></a>, the fingerprint
for <a class="link" href="GwySurface.html#gwy-surface-xy-is-compatible" title="gwy_surface_xy_is_compatible ()"><code class="function">gwy_surface_xy_is_compatible()</code></a> and and possibly other characteristics
in the future.</p>
<p>See <a class="link" href="GwyDataField.html#gwy-data-field-invalidate" title="gwy_data_field_invalidate ()"><code class="function">gwy_data_field_invalidate()</code></a> for discussion of invalidation and examples.</p>
<div class="refsect3">
<a name="gwy-surface-invalidate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-set-from-data-field"></a><h3>gwy_surface_set_from_data_field ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_set_from_data_field (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>);</pre>
<p>Fills the data of a surface from a data field.</p>
<p>The number of points in the new surface will be equal to the number of
points in the field. Lateral coordinates will be equal to the corresponding
<em class="parameter"><code>data_field</code></em>
coordinates; values will be created in regular grid according to
<em class="parameter"><code>data_field</code></em>
's physical size and offset.</p>
<p>Lateral and value units will correspond to <em class="parameter"><code>data_field</code></em>
's units. This means
the field needs to have identical <em class="parameter"><code>x</code></em>
and <em class="parameter"><code>y</code></em>
units.</p>
<div class="refsect3">
<a name="gwy-surface-set-from-data-field.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A two-dimensional data field.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-set-from-data-field-mask"></a><h3>gwy_surface_set_from_data_field_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_set_from_data_field_mask (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyMaskingType" title="enum GwyMaskingType"><span class="type">GwyMaskingType</span></a> masking</code></em>);</pre>
<p>Fills the data of a surface from a data field, possibly using masking.</p>
<div class="refsect3">
<a name="gwy-surface-set-from-data-field-mask.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A two-dimensional data field.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mask</p></td>
<td class="parameter_description"><p>Mask of pixels to include from/exclude, or <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>masking</p></td>
<td class="parameter_description"><p>Masking mode to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-46.html#api-index-2.46">2.46</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-si-unit-xy"></a><h3>gwy_surface_get_si_unit_xy ()</h3>
<pre class="programlisting"><a href="../GwySIUnit.html#GwySIUnit-struct"><span class="returnvalue">GwySIUnit</span></a> *
gwy_surface_get_si_unit_xy (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Returns lateral SI unit of a surface.</p>
<div class="refsect3">
<a name="gwy-surface-get-si-unit-xy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-si-unit-xy.returns"></a><h4>Returns</h4>
<p> SI unit corresponding to the lateral (XY) dimensions of the
surface. Its reference count is not incremented.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-si-unit-z"></a><h3>gwy_surface_get_si_unit_z ()</h3>
<pre class="programlisting"><a href="../GwySIUnit.html#GwySIUnit-struct"><span class="returnvalue">GwySIUnit</span></a> *
gwy_surface_get_si_unit_z (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Returns value SI unit of a surface.</p>
<div class="refsect3">
<a name="gwy-surface-get-si-unit-z.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-si-unit-z.returns"></a><h4>Returns</h4>
<p> SI unit corresponding to the "height" (Z) dimension of the surface.
Its reference count is not incremented.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-set-si-unit-xy"></a><h3>gwy_surface_set_si_unit_xy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_set_si_unit_xy (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="../GwySIUnit.html#GwySIUnit-struct"><span class="type">GwySIUnit</span></a> *si_unit</code></em>);</pre>
<p>Sets the SI unit corresponding to the lateral (XY) dimensions of a surface.</p>
<p>It does not assume a reference on <em class="parameter"><code>si_unit</code></em>
, instead it adds its own
reference.</p>
<div class="refsect3">
<a name="gwy-surface-set-si-unit-xy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>si_unit</p></td>
<td class="parameter_description"><p>SI unit to be set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-set-si-unit-z"></a><h3>gwy_surface_set_si_unit_z ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_set_si_unit_z (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="../GwySIUnit.html#GwySIUnit-struct"><span class="type">GwySIUnit</span></a> *si_unit</code></em>);</pre>
<p>Sets the SI unit corresponding to the "height" (Z) dimension of a surface.</p>
<p>It does not assume a reference on <em class="parameter"><code>si_unit</code></em>
, instead it adds its own
reference.</p>
<div class="refsect3">
<a name="gwy-surface-set-si-unit-z.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>si_unit</p></td>
<td class="parameter_description"><p>SI unit to be set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-value-format-xy"></a><h3>gwy_surface_get_value_format_xy ()</h3>
<pre class="programlisting"><a href="../libgwyddion-GwySIValueFormat.html#GwySIValueFormat"><span class="returnvalue">GwySIValueFormat</span></a> *
gwy_surface_get_value_format_xy (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="../libgwyddion-gwyddionenums.html#GwySIUnitFormatStyle"><span class="type">GwySIUnitFormatStyle</span></a> style</code></em>,
<em class="parameter"><code><a href="../libgwyddion-GwySIValueFormat.html#GwySIValueFormat"><span class="type">GwySIValueFormat</span></a> *format</code></em>);</pre>
<p>Finds value format good for displaying coordinates of a surface.</p>
<div class="refsect3">
<a name="gwy-surface-get-value-format-xy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>style</p></td>
<td class="parameter_description"><p>Unit format style.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>A SI value format to modify, or <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to allocate a new one.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-value-format-xy.returns"></a><h4>Returns</h4>
<p> The value format. If <em class="parameter"><code>format</code></em>
is <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a newly allocated format
is returned, otherwise (modified) <em class="parameter"><code>format</code></em>
itself is returned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-value-format-z"></a><h3>gwy_surface_get_value_format_z ()</h3>
<pre class="programlisting"><a href="../libgwyddion-GwySIValueFormat.html#GwySIValueFormat"><span class="returnvalue">GwySIValueFormat</span></a> *
gwy_surface_get_value_format_z (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="../libgwyddion-gwyddionenums.html#GwySIUnitFormatStyle"><span class="type">GwySIUnitFormatStyle</span></a> style</code></em>,
<em class="parameter"><code><a href="../libgwyddion-GwySIValueFormat.html#GwySIValueFormat"><span class="type">GwySIValueFormat</span></a> *format</code></em>);</pre>
<p>Finds value format good for displaying values of a surface.</p>
<div class="refsect3">
<a name="gwy-surface-get-value-format-z.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>style</p></td>
<td class="parameter_description"><p>Unit format style.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>A SI value format to modify, or <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to allocate a new one.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-value-format-z.returns"></a><h4>Returns</h4>
<p> The value format. If <em class="parameter"><code>format</code></em>
is <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a newly allocated format
is returned, otherwise (modified) <em class="parameter"><code>format</code></em>
itself is returned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-copy-units"></a><h3>gwy_surface_copy_units ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_copy_units (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *target</code></em>);</pre>
<p>Sets lateral and value units of a surface to match another surface.</p>
<div class="refsect3">
<a name="gwy-surface-copy-units.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>Target surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-49.html#api-index-2.49">2.49</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-copy-units-to-surface"></a><h3>gwy_data_field_copy_units_to_surface ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_data_field_copy_units_to_surface (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>);</pre>
<p>Sets lateral and value units of a surface to match a data field.</p>
<div class="refsect3">
<a name="gwy-data-field-copy-units-to-surface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A two-dimensional data field.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-46.html#api-index-2.46">2.46</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-copy-units-to-data-field"></a><h3>gwy_surface_copy_units_to_data_field ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_copy_units_to_data_field (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>);</pre>
<p>Sets lateral and value units of a data field to match a surface.</p>
<div class="refsect3">
<a name="gwy-surface-copy-units-to-data-field.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A two-dimensional data field.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-46.html#api-index-2.46">2.46</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get"></a><h3>gwy_surface_get ()</h3>
<pre class="programlisting"><a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a>
gwy_surface_get (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pos</code></em>);</pre>
<p>Obtains a single surface point.</p>
<p>This function exists <span class="emphasis"><em>only for language bindings</em></span> as it
is very slow compared to simply accessing <em class="parameter"><code>data</code></em>
in <a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> directly in
C.</p>
<div class="refsect3">
<a name="gwy-surface-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>Position in <em class="parameter"><code>surface</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get.returns"></a><h4>Returns</h4>
<p> The point at <em class="parameter"><code>pos</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-set"></a><h3>gwy_surface_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_set (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pos</code></em>,
<em class="parameter"><code><a href="../libgwyddion-Math.html#GwyXYZ"><span class="type">GwyXYZ</span></a> point</code></em>);</pre>
<p>Sets a single surface value.</p>
<p>This function exists <span class="emphasis"><em>only for language bindings</em></span> as it
is very slow compared to simply accessing <em class="parameter"><code>data</code></em>
in <a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> directly in
C.</p>
<div class="refsect3">
<a name="gwy-surface-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>Position in <em class="parameter"><code>surface</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>point</p></td>
<td class="parameter_description"><p>Point to store at given position.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-xrange"></a><h3>gwy_surface_get_xrange ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_get_xrange (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *min</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *max</code></em>);</pre>
<p>Gets the range of X coordinates of a surface.</p>
<p>This information is cached.</p>
<div class="refsect3">
<a name="gwy-surface-get-xrange.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min</p></td>
<td class="parameter_description"><p>Location where to store the minimum value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max</p></td>
<td class="parameter_description"><p>Location where to store the maximum value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-yrange"></a><h3>gwy_surface_get_yrange ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_get_yrange (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *min</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *max</code></em>);</pre>
<p>Gets the range of Y coordinates of a surface.</p>
<p>This information is cached.</p>
<div class="refsect3">
<a name="gwy-surface-get-yrange.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min</p></td>
<td class="parameter_description"><p>Location where to store the minimum value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max</p></td>
<td class="parameter_description"><p>Location where to store the maximum value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-min-max"></a><h3>gwy_surface_get_min_max ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_get_min_max (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *min</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *max</code></em>);</pre>
<p>Gets the range of Z values of a surface.</p>
<p>This information is cached.</p>
<div class="refsect3">
<a name="gwy-surface-get-min-max.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min</p></td>
<td class="parameter_description"><p>Location where to store the minimum value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max</p></td>
<td class="parameter_description"><p>Location where to store the maximum value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-get-data-full"></a><h3>gwy_surface_get_data_full ()</h3>
<pre class="programlisting">const <a href="../libgwyddion-Math.html#GwyXYZ"><span class="returnvalue">GwyXYZ</span></a> *
gwy_surface_get_data_full (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n</code></em>);</pre>
<p>Provides the values of an entire surface as a flat array.</p>
<p>This function, paired with <a class="link" href="GwySurface.html#gwy-surface-set-data-full" title="gwy_surface_set_data_full ()"><code class="function">gwy_surface_set_data_full()</code></a> can be namely useful
in language bindings.</p>
<p>Note that this function returns a pointer directly to <em class="parameter"><code>surface</code></em>
's data.</p>
<div class="refsect3">
<a name="gwy-surface-get-data-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Location to store the count of extracted data points.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-get-data-full.returns"></a><h4>Returns</h4>
<p> The array containing the surface points.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-set-data-full"></a><h3>gwy_surface_set_data_full ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_surface_set_data_full (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code>const <a href="../libgwyddion-Math.html#GwyXYZ"><span class="type">GwyXYZ</span></a> *points</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
<p>Puts back values from a flat array to an entire data surface.</p>
<p>See <a class="link" href="GwySurface.html#gwy-surface-get-data-full" title="gwy_surface_get_data_full ()"><code class="function">gwy_surface_get_data_full()</code></a> for a discussion.</p>
<div class="refsect3">
<a name="gwy-surface-set-data-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>points</p></td>
<td class="parameter_description"><p>Data points to copy to the surface. They replace whatever points
are in <em class="parameter"><code>surface</code></em>
now.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The number of points in <em class="parameter"><code>data</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-xy-is-compatible"></a><h3>gwy_surface_xy_is_compatible ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gwy_surface_xy_is_compatible (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *othersurface</code></em>);</pre>
<p>Checks whether the XY positions of two surfaces are compatible.</p>
<p>Compatible XY positions mean the XY units are the same and the points are
the same. Two surfaces that have the same set of XY points but in different
orders are <span class="emphasis"><em>not</em></span> considered compatible. This is because
the points at the same index in <em class="parameter"><code>data</code></em>
are different and thus calculations
involving data from the two surfaces are impossible. It is necessary to
match the points order in the two surfaces to make this possible.</p>
<p>This information is cached.</p>
<div class="refsect3">
<a name="gwy-surface-xy-is-compatible.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>othersurface</p></td>
<td class="parameter_description"><p>Another surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-xy-is-compatible.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the surfaces are XY-position compatible, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they
are not.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-surface-reduce-points"></a><h3>gwy_surface_reduce_points ()</h3>
<pre class="programlisting"><a class="link" href="GwySurface.html" title="GwySurface"><span class="returnvalue">GwySurface</span></a> *
gwy_surface_reduce_points (<em class="parameter"><code><a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *surface</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> npoints</code></em>);</pre>
<p>Creates a similar surface with smaller number of points.</p>
<p>The functions attempts to choose points from the original surface to cover
its full area, even though points from dense regions are still more likely
to be found in the result than points from sparse regions. As the main
purpose to enable quick rough operations that may take long time with the
full surface, the focus is on speed not fidelity.</p>
<p>The function may employ random selection and thus be be non-deterministic.</p>
<div class="refsect3">
<a name="gwy-surface-reduce-points.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>A surface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>npoints</p></td>
<td class="parameter_description"><p>Requested number of points in the reduced surface. If it is not
smaller than the number of points in <em class="parameter"><code>surface</code></em>
then the function
behaves like <a class="link" href="GwySurface.html#gwy-surface-duplicate" title="gwy_surface_duplicate()"><code class="function">gwy_surface_duplicate()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-surface-reduce-points.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> with reduced number of points.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-48.html#api-index-2.48">2.48</a></p>
</div>
</div>
<div class="refsect1">
<a name="GwySurface.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GwySurface-struct"></a><h3>struct GwySurface</h3>
<pre class="programlisting">struct GwySurface {
guint n;
GwyXYZ *data;
};
</pre>
<p>Object representing surface data.</p>
<p>The <a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> struct contains some public fields that can be directly
accessed for reading. To set them, you must use the <a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> methods.</p>
<div class="refsect3">
<a name="GwySurface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GwySurface-struct.n"></a>n</code></em>;</p></td>
<td class="struct_member_description"><p>Number of points.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../libgwyddion-Math.html#GwyXYZ"><span class="type">GwyXYZ</span></a> *<em class="structfield"><code><a name="GwySurface-struct.data"></a>data</code></em>;</p></td>
<td class="struct_member_description"><p>Surface data. See the introductory section for details.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GwySurfaceClass"></a><h3>struct GwySurfaceClass</h3>
<pre class="programlisting">struct GwySurfaceClass {
GObjectClass g_object_class;
void (*data_changed)(GwySurface *surface);
};
</pre>
<p>Class of surfaces.</p>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
</div>
<div class="refsect1">
<a name="GwySurface.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwySurface-data-changed"></a><h3>The <code class="literal">“data-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> *gwysurface,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The ::data-changed signal is never emitted by surface itself. It
is intended as a means to notify others data field users they should
update themselves.</p>
<div class="refsect3">
<a name="GwySurface-data-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>gwysurface</p></td>
<td class="parameter_description"><p>The <a class="link" href="GwySurface.html" title="GwySurface"><span class="type">GwySurface</span></a> which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>
|
