Skip to content

Commit 1642cc2

Browse files
author
Martin D. Weinberg
committed
Comment improvements only
1 parent cd8cbde commit 1642cc2

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

utils/PhaseSpace/KDE2d.H

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,38 @@
1616

1717
namespace KDE
1818
{
19+
/**
20+
Class for 2D kernel density estimation
21+
22+
Parameters
23+
----------
24+
@param numx: desired grid size in x
25+
@param numy: desired grid size in y
26+
@param xmin: minimum value in x
27+
@param xmax: maximum value in x
28+
@param ymin: minimum value in y
29+
@param ymax: maximum value in y
30+
@param sigmax: smoothing kernel width in x units
31+
@param sigmay: smoothing kernel width in y units
32+
33+
Data input
34+
----------
35+
Can be either a vector of pairs (x,y), an array of x and y
36+
values, or a precomputed histogram-like grid of size (numx,
37+
numy).
38+
39+
Output
40+
------
41+
Smoothed 2D grid in Eigen::MatrixXd format
42+
*/
1943
class KDE2d
2044
{
2145
protected:
2246

2347
//@{
2448
//! Parameters
25-
bool debug = false;
26-
const int minKsize = 7;
49+
bool debug = false; // Set to true for intermediate output
50+
const int minKsize = 7; // Default minimum kernel size
2751
int numx, numy;
2852
double xmin, xmax, ymin, ymax, sigmax, sigmay, delx, dely;
2953
//@}

0 commit comments

Comments
 (0)