File: tophatconvolution.h

package info (click to toggle)
wsclean 3.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,296 kB
  • sloc: cpp: 129,246; python: 22,066; sh: 360; ansic: 230; makefile: 185
file content (30 lines) | stat: -rw-r--r-- 1,028 bytes parent folder | download | duplicates (2)
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
#ifndef MATH_TOPHAT_CONVOLUTION_H_
#define MATH_TOPHAT_CONVOLUTION_H_

#include <aocommon/image.h>

namespace wsclean::tophat_convolution {

/**
 * Perform a convolution with a radial tophat with a given radius (in pixels).
 */
void Convolve(aocommon::Image& input, double radius);

/**
 * Produce an image with a radial tophat function. This means that
 * all pixels outside a specified radius are set to zero, and the other
 * pixels are set to the same non-zero value. The image is normalized such that
 * the full image sums to one.
 *
 * In theory it works for even sizes, but in that case the tophat filter
 * will chose the pixel at (width/2, height/2) as the centre pixel,
 * which means that the filter is not circular/otherwise symmetric.
 * When using an odd size, the tophat filter is circular/symmetric,
 * and that is the recommended usage.
 */
aocommon::Image MakeTopHatImage(size_t width, size_t height,
                                double tophat_radius);

}  // namespace wsclean::tophat_convolution

#endif