API reference¶
Aspatial Indices¶
aspatial.Dissim(data, group_pop_var, …) |
Classic Dissimilarity Index |
aspatial.Gini_Seg(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.Correlation_R(data, group_pop_var, …) |
Classic Correlation Ratio Index |
aspatial.Con_Prof(data, group_pop_var, …) |
Concentration Profile Index |
aspatial.Modified_Dissim(data, …[, iterations]) |
Calculation of Modified Dissimilarity index |
aspatial.Modified_Gini_Seg(data, …[, …]) |
Calculation of Modified Gini Segregation index |
aspatial.Bias_Corrected_Dissim(data, …[, B]) |
Calculation of Bias Corrected Dissimilarity index |
aspatial.Density_Corrected_Dissim(data, …) |
Calculation of Density Corrected Dissimilarity index |
Spatial Indices¶
spatial.Spatial_Prox_Prof(data, …[, m]) |
Calculation of Spatial Proximity Profile |
spatial.Spatial_Dissim(data, group_pop_var, …) |
Calculation of Spatial Dissimilarity index |
spatial.Boundary_Spatial_Dissim(data, …[, …]) |
Calculation of Boundary Spatial Dissimilarity index |
spatial.Perimeter_Area_Ratio_Spatial_Dissim(…) |
Calculation of Perimeter/Area Ratio Spatial Dissimilarity index |
spatial.Spatial_Isolation(data, …[, …]) |
Calculation of Spatial Isolation index |
spatial.Spatial_Exposure(data, …[, alpha, …]) |
Calculation of Spatial Exposure index |
spatial.Spatial_Proximity(data, …[, …]) |
Calculation of Spatial Proximity index |
spatial.Absolute_Clustering(data, …[, …]) |
Calculation of Absolute Clustering index |
spatial.Relative_Clustering(data, …[, …]) |
Calculation of Relative Clustering index |
spatial.Delta(data, group_pop_var, total_pop_var) |
Calculation of Delta index |
spatial.Absolute_Concentration(data, …) |
Calculation of Absolute Concentration index |
spatial.Relative_Concentration(data, …) |
Calculation of Relative Concentration index |
spatial.Absolute_Centralization(data, …[, …]) |
Calculation of Absolute Centralization index |
spatial.Relative_Centralization(data, …[, …]) |
Calculation of Relative Centralization index |
Multigroup Indices¶
aspatial.Multi_Dissim(data, groups) |
Calculation of Multigroup Dissimilarity index |
aspatial.Multi_Gini_Seg(data, groups) |
Calculation of Multigroup Gini Segregation index |
aspatial.Multi_Normalized_Exposure(data, groups) |
Calculation of Multigroup Normalized Exposure index |
aspatial.Multi_Information_Theory(data, groups) |
Calculation of Multigroup Information Theory index |
aspatial.Multi_Relative_Diversity(data, groups) |
Calculation of Multigroup Relative Diversity index |
aspatial.Multi_Squared_Coefficient_of_Variation(…) |
Calculation of Multigroup Squared Coefficient of Variation index |
aspatial.Multi_Diversity(data, groups[, …]) |
Calculation of Multigroup Diversity index |
aspatial.Simpsons_Concentration(data, groups) |
Calculation of Simpson’s Concentration index |
aspatial.Simpsons_Interaction(data, groups) |
Calculation of Simpson’s Interaction index |
aspatial.Multi_Divergence(data, groups) |
Calculation of Multigroup Divergence index |
Profile Wrappers¶
profile.Profile_Aspatial_Segregation(data, …) |
Perform point estimation of selected Aspatial segregation measures at once |
profile.Profile_Spatial_Segregation(data, …) |
Perform point estimation of selected spatial segregation measures at once |
profile.Profile_Segregation(data, …) |
Perform point estimation of selected segregation measures at once |
Inference Wrappers¶
inference.Infer_Segregation(seg_class[, …]) |
Perform inference for a single segregation measure |
inference.Compare_Segregation(seg_class_1, …) |
Perform inference comparison for a two segregation measures |
Decomposition¶
decomposition.Decompose_Segregation(index1, …) |
Decompose segregation differences into spatial and attribute components. |