blue_cwl.population_utils

Functions applied on libsonata populations.

Functions

get_HRM_counts(population)	Return the number of cells for each (hemisphere, region, mtype) in the population.
get_HRM_positions(population)	Return positions in population indexed by hemisphere, region, and mtype.
get_pathways(edge_population, ...)	Return the properties of the pathways.

blue_cwl.population_utils.get_HRM_counts(population: NodePopulation) → Series

Return the number of cells for each (hemisphere, region, mtype) in the population.

blue_cwl.population_utils.get_HRM_positions(population: NodePopulation) → DataFrame

Return positions in population indexed by hemisphere, region, and mtype.

blue_cwl.population_utils.get_pathways(edge_population: EdgePopulation, source_node_population: NodePopulation, target_node_population: NodePopulation, properties: list[str]) → DataFrame

Return the properties of the pathways.

Parameters:

• edge_population – The libsonata edge population.

• source_node_population – The source node population.

• target_node_population – The target node population.

• properties – The list of N properties to fetch.

Returns:

A dataframe of 2xN columns where properties are prefixed by ‘source’ or ‘target’. For example for two properties [region, mtype] the resulting dataframe will have [source_region, source_mtype, target_region, target_mtype]