Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

dict keywords:

    • seg : array of int - 2-d segment index (beginning from 0), e.g. in CSPAD consisting of 32 segments this index should be in the range from 0 to 31
    • row : array of int - row (beginning from 0) of the central pixel with maximal intensity in the square region defined by rank
    • col : array of int - column (beginning from 0) of the central pixel with maximal intensity in the square region defined by rank
    • npix : array of int - number of pixels accounted in the peak
    • amp_max : array of float - maximal intensity among peak pixels
    • amp_total : array of float - total intensity of pixels accounted in the peak
    • row_cgmean : array of float - row "center of gravity" row coordinate evaluated for pixels accounted in the peak using their intensities as weights
    • col_cgmean : array of float - column  "center of gravity" coordinate column coordinate evaluated for pixels accounted in the peak using their intensities as weights
    • raw_cgrms : array of float - row "center of gravity" coordinate row coordinate rms
    • col_cgrms : array of float - column  "center of gravity" coordinate  column coordinate rms
    • base : array of float - per pixel base level mean estimated for pixels in the ring region (parameters base_r, base_dr)  around peak center
    • noise : array of float - per pixel base level rms estimated for pixels in the ring region (parameters base_r, base_dr) around peak center
    • son : array of float - signal over noise ratio estimated as amp_total / (noise * sqrt(npix))
    • peak : list of peak objects
      peak attributes:
      • pixrow : array of int - row index for pixels accounted in the peak
      • pixcol : array of int - column index for pixels accounted in the peak
      peak methods:

...

  • peaks_two_thr - is a two-threshold peak-finding algorithm searching for groups of connected pixels with intensity above thr_lowin the square region restricted by the parameter rank around central pixel with intensity exceeding thr_high in the region restricted by the radial parameter rank. In the loop over all pixels each pixel with intensity grater or equal thr_high is considered as a peak candidate. For each candidate recursive algorithm is launched and searches for a group of connected pixels with intensity grater or equal thr_low in the square region with dimensions 2*rank+1 pixel in rows and columns. Pixels of the group are marked as busy on 2-d map and are not used for in other groups. Central pixel of the peak candidate should have maximal intensity in the group of connected pixels, otherwise recursion is terminated and all group pixels released for further search. Two neighbor pixels with intensity above thr_low having common boarder are assumed connected. Two pixels having a single common vertex are assumed disconnected. Base level mean, bkgdbase, and , rms, noise values , values are evaluated for pixels in the ring with internal radius base_r and width base_dr around central pixel. Pixels with intensity above thr_low are excluded from evaluation of the base level parameters.
  • peaks_adapt_thr - searches  is an adaptive-threshold peak-finding algorithm searching peak candidates as group of connected pixels with intensity above dynamically estimated evaluated threshold around local intensity maximums of specified rank.  Maps of local maximums and minimums of specified rank are generated for data array. Parameter rank defines a square region with dimensions 2*rank+1 pixels in rows and columns around center pixel. Each local maximum is of specified rank is considered as a peak candidate. Its base level mean, bkgdbase, and rms, noise, values are evaluated using surrounding pixels in the ring with internal radius base_r and width base_dr. Pixels marked as local maximums and minimums (for symmetry) of specified rank in rows and columns are excluded in evaluation of the base level parameters. NOTE: due to excluded extremes the base level rms is under-estimated in this algorithm, so, set parameter nsigm wisely.Then, for each peak candidate local adaptive-threshold parameter thr=bkgdbase+nsigm*noise (no exclusion for nsigm=0) is  is used. Recursive algorithm searches for the group of connected pixels with intensity above local threshold thr in the rank-restricted region.


NOTE: due to excluded extremes the base level rms is under-estimated in this algorithm, so, set parameter nsigm wisely. 

Other stages of all algorithms are about the same.

  • returned values of  amp_max and amp_total are base level corrected by subtracting bkgd and bkgd base and base*npix, respectively, if do_base_sub=True.
  • signal over noise son is evaluated as amp_total / (noise * sqrt(npix)),
  • output list of peaks is generated from the list of seed peaks complying with selection parameters npix_min, npix_max, amax_thr, atot_thr, son_min .

...