Name

• peak_search - Search peaks in an image. The peak is defined as a local maximum or minimum.

Usage

output = peak_search(image, npeak, invert, print_screen)

Input

image

image from which peaks are searched, which can be 1D, 2D or 3D images

npeak

number of peaks to be given (default = 1)

invert

search for maximum (default = 1) or minimum( =-1)

print_screen

print the results in format on the screen (default set as 0, not print)

Output

output

The output is a list of lists: peaks[i][j].

i specifies the indices of peaks, and j denotes the elements in each peak. The elements in each peak are arranged as follows:

1. peak value;

2. Coordinates $X, Y, Z$ of peak. $Y$, $Z$ will be omitted if the image is 1D or 2D, respectively;

3. relative peak value (ratio with the highest peak, value varies from 0 to 1);

4. Coordinates of $X Y Z$ in image center coordinate system. $Y$, $Z$ will be omitted if the image is 1D or 2D, respectively.

Description

1. The peak is defined as a local maximum.

2. In 1D, the program uses circular boundary conditions:`Img(0,0,0)= Img(NX,NY,NZ)`. In 2D and 3D, the search is restricted to the interior 1:size-2.

Author / Maintainer

Zhong Huang/Pawel A. Penczek

Keywords

category 1

UTILITIES

Files

utilities.py

Maturity

stable

works for most people, has been tested; test cases/examples available.

Bugs

None. It is perfect.