mapclassify.NaturalBreaks

class mapclassify.NaturalBreaks(y, k=5, initial=10)[source]

Natural Breaks Map Classification.

Parameters:
ynumpy.array

\((n,1)\), values to classify.

kpython:int (default 5)

The number of classes required.

initialpython:int (default 10)

The number of initial solutions generated with different centroids. The best of initial results are returned.

Examples

>>> import mapclassify
>>> import numpy
>>> numpy.random.seed(123456)
>>> cal = mapclassify.load_example()
>>> nb = mapclassify.NaturalBreaks(cal, k=5)
>>> nb.k
5
>>> nb.counts.tolist()
[49, 3, 4, 1, 1]
>>> nb.bins
array([  75.29,  192.05,  370.5 ,  722.85, 4111.45])
Attributes:
ybnumpy.array

\((n,1)\), bin IDs for observations.

binsnumpy.array

\((k,1)\), the upper bounds of each class.

kpython:int

The number of classes.

countsnumpy.array

\((k,1)\), the number of observations falling in each class.

__init__(y, k=5, initial=10)[source]

Methods

__init__(y[, k, initial])

find_bin(x)

Sort input or inputs according to the current bin estimate.

get_adcm()

Absolute deviation around class median (ADCM).

get_fmt()

get_gadf()

Goodness of absolute deviation of fit.

get_legend_classes([fmt])

Format the strings for the classes on the legend.

get_tss()

Returns sum of squares over all class means.

make(*args, **kwargs)

Configure and create a classifier that will consume data and produce classifications, given the configuration options specified by this function.

plot(gdf[, border_color, border_width, ...])

Plot a mapclassifier object.

set_fmt(fmt)

table()

update([y, inplace])

Add data or change classification parameters.

Attributes

fmt

update(y=None, inplace=False, **kwargs)[source]

Add data or change classification parameters.

Parameters:
ynumpy.array (default python:None)

\((n,1)\), array of data to classify.

inplacebool (default python:False)

Whether to conduct the update in place or to return a copy estimated from the additional specifications.

**kwargspython:dict

Additional parameters that are passed to the __init__ function of the class. For documentation, check the class constructor.