API reference

Aspatial Indices

aspatial.Dissim(data, group_pop_var, …)

Classic Dissimilarity Index

aspatial.GiniSeg(data, group_pop_var, …)

Classic Gini Segregation Index

aspatial.Entropy(data, group_pop_var, …)

Classic Entropy Index

aspatial.Isolation(data, group_pop_var, …)

Classic Isolation Index

aspatial.Exposure(data, group_pop_var, …)

Classic Exposure Index

aspatial.Atkinson(data, group_pop_var, …)

Classic Atkinson Index

aspatial.CorrelationR(data, group_pop_var, …)

Classic Correlation Ratio Index

aspatial.ConProf(data, group_pop_var, …[, m])

Concentration Profile Index

aspatial.ModifiedDissim(data, group_pop_var, …)

Calculation of Modified Dissimilarity index

aspatial.ModifiedGiniSeg(data, …[, iterations])

Calculation of Modified Gini Segregation index

aspatial.BiasCorrectedDissim(data, …[, B])

Calculation of Bias Corrected Dissimilarity index

aspatial.DensityCorrectedDissim(data, …[, …])

Calculation of Density Corrected Dissimilarity index

aspatial.MinMax(data, group_pop_var, …)

Calculation of the Aspatial version of SpatialMinMax

Spatial Indices

spatial.SpatialProxProf(data, group_pop_var, …)

Calculation of Spatial Proximity Profile

spatial.SpatialDissim(data, group_pop_var, …)

Calculation of Spatial Dissimilarity index

spatial.BoundarySpatialDissim(data, …[, …])

Calculation of Boundary Spatial Dissimilarity index

spatial.PerimeterAreaRatioSpatialDissim(…)

Calculation of Perimeter/Area Ratio Spatial Dissimilarity index

spatial.DistanceDecayIsolation(data, …[, …])

Calculation of Distance Decay Isolation index

spatial.DistanceDecayExposure(data, …[, …])

Calculation of Distance Decay Exposure index

spatial.SpatialProximity(data, …[, alpha, …])

Calculation of Spatial Proximity index

spatial.AbsoluteClustering(data, …[, …])

Calculation of Absolute Clustering index

spatial.RelativeClustering(data, …[, …])

Calculation of Relative Clustering index

spatial.Delta(data, group_pop_var, total_pop_var)

Calculation of Delta index

spatial.AbsoluteConcentration(data, …)

Calculation of Absolute Concentration index

spatial.RelativeConcentration(data, …)

Calculation of Relative Concentration index

spatial.AbsoluteCentralization(data, …[, …])

Calculation of Absolute Centralization index

spatial.RelativeCentralization(data, …[, …])

Calculation of Relative Centralization index

spatial.SpatialMinMax(data, group_pop_var, …)

Spatial MinMax Index.

Multi-Scalar Spatial Measures

spatial.compute_segregation_profile(gdf[, …])

Compute multiscalar segregation profile.

Multigroup Indices

aspatial.MultiDissim(data, groups)

Calculation of Multigroup Dissimilarity index

aspatial.MultiGiniSeg(data, groups)

Calculation of Multigroup Gini Segregation index

aspatial.MultiNormalizedExposure(data, groups)

Calculation of Multigroup Normalized Exposure index

aspatial.MultiInformationTheory(data, groups)

Calculation of Multigroup Information Theory index

aspatial.MultiRelativeDiversity(data, groups)

Calculation of Multigroup Relative Diversity index

aspatial.MultiSquaredCoefficientVariation(…)

Calculation of Multigroup Squared Coefficient of Variation index

aspatial.MultiDiversity(data, groups[, …])

Calculation of Multigroup Diversity index

aspatial.SimpsonsConcentration(data, groups)

Calculation of Simpson’s Concentration index

aspatial.SimpsonsInteraction(data, groups)

Calculation of Simpson’s Interaction index

aspatial.MultiDivergence(data, groups)

Calculation of Multigroup Divergence index

Local Indices

local.MultiLocationQuotient(data, groups)

Calculation of Location Quotient index for each group and unit

local.MultiLocalDiversity(data, groups)

Calculation of Local Diversity index for each group and unit

local.MultiLocalEntropy(data, groups)

Calculation of Local Entropy index for each unit

local.MultiLocalSimpsonInteraction(data, groups)

Calculation of Local Simpson Interaction index for each unit

local.MultiLocalSimpsonConcentration(data, …)

Calculation of Local Simpson concentration index for each unit

local.LocalRelativeCentralization(data, …)

Calculation of Local Relative Centralization index for each unit

Batch Compute Wrappers

compute_all.ComputeAllAspatialSegregation(…)

Perform point estimation of selected Aspatial segregation measures at once

compute_all.ComputeAllSpatialSegregation(…)

Perform point estimation of selected spatial segregation measures at once

compute_all.ComputeAllSegregation(data, …)

Perform point estimation of selected segregation measures at once

Inference Wrappers

inference.SingleValueTest(seg_class[, …])

Perform inference for a single segregation measure

inference.TwoValueTest(seg_class_1, seg_class_2)

Perform inference comparison for a two segregation measures

Decomposition

decomposition.DecomposeSegregation(index1, …)

Decompose segregation differences into spatial and attribute components.

Network

network.get_osm_network(geodataframe[, …])

Download a street network from OSM.

network.calc_access(geodataframe, network[, …])

Calculate access to population groups.

Util

util.project_gdf(gdf[, to_crs, to_latlong])

lovingly copied from OSMNX <https://github.com/gboeing/osmnx/blob/master/osmnx/projection.py>