Action: KDE
| Module | gridtools |
|---|---|
| Description | Usage |
| Create a histogram from the input scalar/vector/matrix using KDE |   |
| output value | type |
| a function on a grid that was obtained by doing a Kernel Density Estimation using the input arguments | grid |
Input
The arguments that serve as the input for this action are specified using one or more of the keywords in the following table.
| Keyword | Type | Description |
|---|---|---|
| ARG | scalar/vector/matrix | the label for the value that should be used to construct the histogram |
Further details and examples
Text from manual goes here
Syntax
The following table describes the keywords and options that can be used with this action
| Keyword | Type | Default | Description |
|---|---|---|---|
| ARG | input | none | the label for the value that should be used to construct the histogram |
| GRID_MIN | compulsory | auto | the lower bounds for the grid |
| GRID_MAX | compulsory | auto | the upper bounds for the grid |
| METRIC | compulsory | none | the inverse covariance to use for the kernels that are added to the grid |
| CUTOFF | compulsory | 6.25 | the cutoff at which to stop evaluating the kernel functions is set equal to sqrt(2x)bandwidth in each direction where x is this number |
| KERNEL | compulsory | GAUSSIAN | the kernel function you are using |
| CONCENTRATION | compulsory | none | the concentration parameter for Von Mises-Fisher distributions (only required for SPHERICAL_KDE) |
| SERIAL | optional | false | do the calculation in serial |
| HEIGHTS | optional | not used | this keyword takes the label of an action that calculates a vector of values |
| VOLUMES | optional | not used | this keyword take the label of an action that calculates a vector of values |
| BANDWIDTH | optional | not used | the bandwidths for kernel density esimtation |
| GRID_BIN | optional | not used | the number of bins for the grid |
| IGNORE_IF_OUT_OF_RANGE | optional | false | if a kernel is outside of the range of the grid it is safe to ignore |
| GRID_SPACING | optional | not used | the approximate grid spacing (to be used as an alternative or together with GRID_BIN) |