File: peaks.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 (78 lines) | stat: -rw-r--r-- 3,073 bytes parent folder | download | duplicates (2)
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
/*
 *  $Id: peaks.h 24413 2021-10-22 15:58:08Z yeti-dn $
 *  Copyright (C) 2016 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_PEAKS_H__
#define __GWY_PEAKS_H__

#include <glib.h>
#include <libgwyddion/gwymath.h>
#include <libprocess/dataline.h>

G_BEGIN_DECLS

typedef enum {
    GWY_PEAK_BACKGROUND_ZERO   = 0,
    GWY_PEAK_BACKGROUND_MMSTEP = 1,
} GwyPeakBackgroundType;

typedef enum {
    GWY_PEAK_ORDER_ABSCISSA   = 0,
    GWY_PEAK_ORDER_PROMINENCE = 1,
} GwyPeakOrderType;

typedef enum {
    GWY_PEAK_PROMINENCE = 0,
    GWY_PEAK_ABSCISSA   = 1,
    GWY_PEAK_HEIGHT     = 2,
    GWY_PEAK_AREA       = 3,
    GWY_PEAK_WIDTH      = 4,
} GwyPeakQuantity;

typedef struct _GwyPeaks GwyPeaks;

#define GWY_TYPE_PEAKS (gwy_peaks_get_type())

GType     gwy_peaks_get_type        (void)                              G_GNUC_CONST;
GwyPeaks* gwy_peaks_new             (void)                              G_GNUC_MALLOC;
GwyPeaks* gwy_peaks_copy            (GwyPeaks *peaks)                   G_GNUC_MALLOC;
void      gwy_peaks_free            (GwyPeaks *peaks);
void      gwy_peaks_set_background  (GwyPeaks *peaks,
                                     GwyPeakBackgroundType background);
void      gwy_peaks_set_order       (GwyPeaks *peaks,
                                     GwyPeakOrderType order);
guint     gwy_peaks_analyze         (GwyPeaks *peaks,
                                     const gdouble *xdata,
                                     const gdouble *ydata,
                                     guint n,
                                     guint maxpeaks);
guint     gwy_peaks_analyze_xy      (GwyPeaks *peaks,
                                     const GwyXY *xydata,
                                     guint n,
                                     guint maxpeaks);
guint     gwy_peaks_analyze_dataline(GwyPeaks *peaks,
                                     GwyDataLine *dline,
                                     guint maxpeaks);
guint     gwy_peaks_n_peaks         (GwyPeaks *peaks);
void      gwy_peaks_get_quantity    (GwyPeaks *peaks,
                                     GwyPeakQuantity quantity,
                                     gdouble *data);

G_END_DECLS

#endif /* __GWY_PEAKS_H__ */

/* 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 : */