libcrystfel  0.10.1
Enumerations | Functions
peaks.h File Reference


enum  peak_search_method {


const char * str_peaksearch (enum peak_search_method meth)
enum peak_search_method parse_peaksearch (const char *arg)
int * make_BgMask (struct image *image, struct detgeom_panel *p, int pn, double ir_inn)
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)
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 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)
int indexing_peak_check (struct image *image, Crystal **crystals, int n_cryst, int multi_mode)
int peak_sanity_check (struct image *image, Crystal **crystals, int n_cryst)
void validate_peaks (struct image *image, double min_snr, int ir_inn, int ir_mid, int ir_out, int use_saturated, int check_snr)
double estimate_peak_resolution (ImageFeatureList *peaks, double lambda, struct detgeom *det)

Detailed Description

Peak search functions

Function Documentation

◆ indexing_peak_check()

int indexing_peak_check ( struct image image,
Crystal **  crystals,
int  n_cryst,
int  multi_mode 
imageAn image structure
crystalsPointer to array of pointers to crystals
n_crystThe number of crystals
multi_modeWhether the thresholds should be set for multi-lattice indexing

Checks whether the peaks in image appear to be explained by the crystals provided.

Returns 1 if the peaks appear to be well-explained by the crystals. Otherwise, if the indexing solutions appear to be "bad", returns 0.

◆ peak_sanity_check()

int peak_sanity_check ( struct image image,
Crystal **  crystals,
int  n_cryst 

Deprecated: use indexing_peak_check instead

◆ search_peaks_peakfinder8()

int search_peaks_peakfinder8 ( struct image image,
int  max_n_peaks,
float  threshold,
float  min_snr,
int  min_pix_count,
int  max_pix_count,
int  local_bg_radius,
int  min_res,
int  max_res,
int  use_saturated 
imageAn image structure
max_n_peaksThe maximum number of peaks to be searched for
thresholdThe image threshold value, in detector units
min_snrThe minimum signal to noise ratio for a peak
min_pix_countThe minimum number of pixels in a peak
max_pix_countThe maximum number of pixels in a peak
local_bg_radiusThe averaging radius for background calculation
min_resThe minimum number of pixels out from the center
max_resThe maximum number of pixels out from the center
use_saturatedWhether saturated peaks should be considered

Runs the peakfinder8 peak search algorithm. This is a thin wrapper which creates an empty ImageFeatureList for image, then calls the actual peakfinder8 function, found in peakfinder8.h.