API reference

Single Group Indices

singlegroup.AbsoluteCentralization(data, ...)

Absolute Centralization Index.

singlegroup.AbsoluteClustering(data, ...[, ...])

Absolute Clustering Index.

singlegroup.AbsoluteConcentration(data, ...)

Absolute Concentration Index.

singlegroup.Atkinson(data, group_pop_var, ...)

Atkinson Index.

singlegroup.BiasCorrectedDissim(data, ...[, ...])

Bias Corrected Dissimilarity Index.

singlegroup.BoundarySpatialDissim(data, ...)

Boundary-Area Dissimilarity Index.

singlegroup.ConProf(data, group_pop_var, ...)

ConProf Index.

singlegroup.CorrelationR(data, ...[, w, ...])

CorrelationR Index.

singlegroup.Delta(data, group_pop_var, ...)

Delta Index.

singlegroup.DensityCorrectedDissim(data, ...)

Density Corrected Dissimilarity Index.

singlegroup.Dissim(data, group_pop_var, ...)

Dissimilarity Index.

singlegroup.DistanceDecayInteraction(data, ...)

Distance-Decay Interaction Index.

singlegroup.DistanceDecayIsolation(data, ...)

Distance-Decay Isolation Index.

singlegroup.Entropy(data, group_pop_var, ...)

Entropy Index.

singlegroup.Gini(data, group_pop_var, ...[, ...])

Gini Index.

singlegroup.Interaction(data, group_pop_var, ...)

Interaction Index.

singlegroup.Isolation(data, group_pop_var, ...)

Isolation Index.

singlegroup.MinMax(data, group_pop_var, ...)

Min-Max Index.

singlegroup.ModifiedDissim(data, ...[, ...])

Modified Dissimilarity Index.

singlegroup.ModifiedGini(data, ...[, ...])

Modified Gini Index.

singlegroup.PARDissim(data, group_pop_var, ...)

Perimeter-Area Ratio Dissimilarity Index.

singlegroup.RelativeCentralization(data, ...)

Relative Centralization Index.

singlegroup.RelativeClustering(data, ...[, ...])

Relative Clustering Index.

singlegroup.RelativeConcentration(data, ...)

Relative Concentration Index.

singlegroup.SpatialDissim(data, ...[, w, ...])

Spatial Dissimilarity Index.

singlegroup.SpatialProximity(data, ...[, ...])

Spatial Proximity Index.

singlegroup.SpatialProxProf(data, ...[, w, m])

Spatial Proximity Profile Index.

Multigroup Indices

multigroup.GlobalDistortion(data[, groups, ...])

Multigroup Global Distortion Index.

multigroup.MultiDissim(data, groups[, w, ...])

Dissimilarity Index.

multigroup.MultiDivergence(data, groups[, ...])

Multi Divergence Index.

multigroup.MultiDiversity(data, groups[, w, ...])

Multigroup Diversity Index.

multigroup.MultiGini(data, groups[, w, ...])

Multigroup Gini Index.

multigroup.MultiInfoTheory(data, groups[, ...])

Multigroup Information Theory Index.

multigroup.MultiNormExposure(data, groups[, ...])

Multigroup INormalized Exposure Index.

multigroup.MultiRelativeDiversity(data, groups)

Multigroup Relative Diversity Index.

multigroup.MultiSquaredCoefVar(data, groups)

Multigroup Squared Coefficient of Variation Index.

multigroup.SimpsonsConcentration(data, groups)

Simpsons Concentration Index.

multigroup.SimpsonsInteraction(data, groups)

Simpsons Concentration Index.

Local Indices

local.LocalDistortion(data[, groups, ...])

Multigroup Local Distortion Coefficients.

local.LocalRelativeCentralization(data[, ...])

Multigroup Local Simpson's Concentration Index.

local.MultiLocalDiversity(data, groups[, w, ...])

Multigroup Local Diversity Index.

local.MultiLocalEntropy(data, groups[, w, ...])

Multigroup Local Entropy Index.

local.MultiLocationQuotient(data, groups[, ...])

Multigroup Local Diversity Index.

local.MultiLocalSimpsonInteraction(data, groups)

Multigroup Local Simpson Interaction Index.

local.MultiLocalSimpsonConcentration(data, ...)

Multigroup Local Simpson's Concentration Index.

Dynamics

dynamics.compute_multiscalar_profile(gdf[, ...])

Compute multiscalar segregation profile.

dynamics.compute_divergence_profiles(gdf, groups)

A segregation metric using Kullback-Leiber (KL) divergence to quantify the difference in the population characteristics between (1) an area and (2) the total population.

Batch Computation

batch.batch_compute_singlegroup(gdf, ...[, ...])

Batch compute single-group indices.

batch.batch_compute_multigroup(gdf, groups, ...)

Batch compute multi-group indices.

batch.batch_multiscalar_singlegroup(gdf, ...)

Batch compute multiscalar profiles for single-group indices.

batch.batch_multiscalar_multigroup(gdf, ...)

Batch compute multiscalar profiles for multi-group indices.

Inference

inference.SingleValueTest(seg_class[, ...])

Statistical inference for a single segregation measure.

inference.TwoValueTest(seg_class_1, seg_class_2)

Perform comparative inference for two segregation measures.

inference.simulate_bootstrap_resample(df, ...)

Generate bootstrap replications of the units with replacement of the same size of the original data.

inference.sim_composition(df1, df2, ...)

Simulate the spatial distribution of a population group in a region using the CDF of a comparison region.

inference.sim_dual_composition(df1, df2, ...)

Apply the 'composition' for both minority and complementary groups.

inference.simulate_evenness(df[, group, ...])

Simulate even redistribution of population groups across spatial units.

inference.simulate_evenness_geo_permutation(df)

Simulate evenness followed by random permutation of geographic units.

inference.simulate_geo_permutation(df, **kwargs)

Simulate a synthetic dataset by random permutation of geographic units.

inference.simulate_null([iterations, ...])

Simulate a series of index values in parallel to serve as a null distribution.

inference.simulate_person_permutation(df[, ...])

Simulate the permutation of individuals across spatial units.

inference.sim_share(df1, df2, ...)

Simulate the spatial population distribution of a region using the CDF of a comparison region.

inference.simulate_systematic_randomization(df)

Simulate systematic redistribution of population groups across spatial units.

inference.simulate_systematic_geo_permutation(df)

Simulate systematic redistribution followed by random permutation of geographic units.

Decomposition

decomposition.DecomposeSegregation(index1, ...)

Decompose segregation differences into spatial and attribute components.

Network

network.compute_travel_cost_matrix(origins, ...)

Compute a shortest path matrix from a pandana network

network.project_network(network[, ...])

Reproject a pandana.Network object into another coordinate system