aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/peaks.h
blob: d6d5c1f9cb022a157ef5983135c5dcb0a4c2d277 (plain)
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
/*
 * peaks.h
 *
 * Peak search and other image analysis
 *
 * Copyright © 2012-2021 Deutsches Elektronen-Synchrotron DESY,
 *                       a research centre of the Helmholtz Association.
 *
 * Authors:
 *   2010-2020 Thomas White <taw@physics.org>
 *   2017      Valerio Mariani <valerio.mariani@desy.de>
 *   2017-2018 Yaroslav Gevorkov <yaroslav.gevorkov@desy.de>
 *
 * This file is part of CrystFEL.
 *
 * CrystFEL 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 3 of the License, or
 * (at your option) any later version.
 *
 * CrystFEL 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 CrystFEL.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef PEAKS_H
#define PEAKS_H

#include <pthread.h>

#include "reflist.h"
#include "crystal.h"
#include "image.h"
#include "detgeom.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * \file peaks.h
 * Peak search functions
 */

enum peak_search_method {
	PEAK_PEAKFINDER9,
	PEAK_PEAKFINDER8,
	PEAK_ZAEF,
	PEAK_HDF5,
	PEAK_CXI,
	PEAK_MSGPACK,
	PEAK_NONE,
	PEAK_ERROR
};

extern const char *str_peaksearch(enum peak_search_method meth);

extern enum peak_search_method parse_peaksearch(const char *arg);

extern int *make_BgMask(struct image *image, struct detgeom_panel *p,
                        int pn, double ir_inn);

extern void search_peaks(struct image *image, float threshold,
                         float min_gradient, float min_snr, double ir_inn,
                         double ir_mid, double ir_out, int use_saturated);

extern int search_peaks_peakfinder8(struct image *image, int max_n_peaks,
                                    float threshold, float min_snr,
                                    int mix_pix_count, int max_pix_count,
                                    int local_bg_radius, int min_res,
                                    int max_res, int use_saturated,
                                    int fast_mode, void *private_data);

extern int search_peaks_peakfinder9(struct image *image,
                                    float min_snr_biggest_pix,
                                    float min_snr_peak_pix,
                                    float min_snr_whole_peak, float min_sig,
                                    float min_peak_over_neighbour,
                                    int window_radius);

extern int indexing_peak_check(struct image *image, Crystal **crystals,
                               int n_cryst, int multi_mode);

extern int peak_sanity_check(struct image *image, Crystal **crystals,
                             int n_cryst);

extern void validate_peaks(struct image *image, double min_snr,
                           int ir_inn, int ir_mid, int ir_out,
                           int use_saturated, int check_snr);

extern double estimate_peak_resolution(ImageFeatureList *peaks,
                                       double lambda,
                                       struct detgeom *det);

#ifdef __cplusplus
}
#endif

#endif	/* PEAKS_H */