segregation.multigroup.MultiGini

class segregation.multigroup.MultiGini(data, groups, w=None, network=None, distance=None, decay='linear', function='triangular', precompute=False, **kwargs)

Multigroup Gini Index.

Parameters:

datapandas.DataFrame or geopandas.GeoDataFrame, required

dataframe or geodataframe if spatial index holding data for location of interest

groupslist, required

list of columns on dataframe holding population totals for each group

wlibpysal.weights.KernelW, optional

lipysal spatial kernel weights object used to define an egohood

networkpandana.Network

pandana Network object representing the study area

distanceint

Maximum distance (in units of geodataframe CRS) to consider the extent of the egohood

decaystr

type of decay function to apply. Options include

precomputebool

Whether to precompute the pandana Network object

Attributes:

statisticfloat

Multigroup Dissimilarity Index value

core_dataa pandas DataFrame

DataFrame that contains the columns used to perform the estimate.

__init__(data, groups, w=None, network=None, distance=None, decay='linear', function='triangular', precompute=False, **kwargs)

Init.

Methods

__init__(data, groups[, w, network, ...])

Init.