Source Detection Algorithms

API/Reference

Photometry.Detection.PeakMesh — Type
PeakMesh(box_size=(3, 3), nsigma=3.0)

Detect sources as local peaks above a threshold.

A pixel is extracted when it is a strict local maximum within the box of size box_size centered on it, and its value is greater than the pixel-wise threshold error * nsigma computed in extract_sources.

box_size is the box size along x and y (the first and second array axes); a single integer gives a square box. Sizes must be positive, and an even size is rounded up to the next odd size so that the box stays centered on the pixel.

Note

Only strict local maxima are extracted. A plateau of equal-valued pixels, e.g. a saturated or clipped star core, has no strict maximum and is skipped, as is any pixel with a NaN neighbour.

Example

julia> pm = PeakMesh((7, 7), 3.0)
PeakMesh
  box_size: Tuple{Int64, Int64}
  nsigma: Float64 3.0
source