PitchKit
API Reference@pitchkit/coreInterfaces

KdeGrid

Defined in: packages/core/src/kde/density.ts:21

A kernel density estimate sampled on a regular grid over the pitch. values is row-major (row * cols + col), each entry the estimated density at that cell's centre.

The grid is laid out in the extent frame: cell (col, row) spans col * cellWidth to (col + 1) * cellWidth across 0..length, and the same down 0..width. Pass a cell's corners through fromExtentFrame to get provider coordinates; for corner-origin providers that is the identity, for a centre-origin pitch it is not (D5, #90).

Properties

PropertyModifierTypeDescriptionDefined in
bandwidthXreadonlynumberThe bandwidths actually used, whether given or derived by Silverman's rule.packages/core/src/kde/density.ts:31
bandwidthYreadonlynumber-packages/core/src/kde/density.ts:32
cellHeightreadonlynumber-packages/core/src/kde/density.ts:25
cellWidthreadonlynumber-packages/core/src/kde/density.ts:24
colsreadonlynumber-packages/core/src/kde/density.ts:22
maxValuereadonlynumberHighest density in values — 0 when there's no data.packages/core/src/kde/density.ts:29
rowsreadonlynumber-packages/core/src/kde/density.ts:23
valuesreadonlyreadonly number[]Row-major density at each cell centre; length cols * rows.packages/core/src/kde/density.ts:27

On this page