Skip to content
This repository has been archived by the owner on Jul 3, 2022. It is now read-only.

Latest commit

 

History

History
32 lines (17 loc) · 2.11 KB

README.md

File metadata and controls

32 lines (17 loc) · 2.11 KB

array-blur

# blur() · Source

Creates a blur transformer, which can blur (or smooth) an array of values by three iterations of a moving average transform.

# blur.radius([radius])

If radius is specified, sets the radius of the transformation: on each iteration, the value of a point is transformed into the mean value of itself and the radius points of data surrounding it on the left and on the right (taking into account the edges). If radius is not specified, return the current radius (if horizontal and vertical radii have been set separately, returns their average value). If radius is not an integer value, the blurring is applied partially. Defaults to 5.

# blur.value([value])

If value is specified, sets the value accessor, which will read the array. If not specified, return the current number. Defaults to the special null accessor, which copies the values directly (faster than an identity function).

Example:

const blurred = blur().value(d => d.temperature)(data);

# blur.width([width])

If width is specified, sets the width of the transformation, otherwise returns the current width. When 0 < width < length, blur considers that the array describes values in two dimensions—as a rectangle of a certain width (height inferred as length divided by width). In that case each iteration involves an horizontal (x) blurring, followed by a vertical (y) blurring. Defaults to undefined (horizontal dimension).

# blur.radiusX([radius])

If radius is specified, sets the horizontal radius of the transformation, otherwise returns it. (Use 0 for vertical blurring.)

# blur.radiusY([radius])

If radius is specified, sets the vertical radius of the transformation, otherwise returns it. (Use 0 for horizontal blurring.)