nrv.nmod.utils

Description

nmod util: utils function and class specific to nmod sub-package.

nmod utils mostly gather tools to build axon populations.

Classes

Placer([geom, delta, delta_trace, delta_in, ...])

A class for drawing circles-inside-a-circle.

Functions

dist_matrix(X)	Get a matrix containing the distance of three array containg the position and radius of various circles.
get_ppop_info(y, z, r[, verbose, with_all_dist])	Compute basic geometric statistics for a placed circle population.
axon_packer(diameters[, y_gc, z_gc, delta, ...])	Axon Packing algorithm: this operation takes a vector of diameter (random population) and places it at best.
get_circular_contour(axons_diameters, ...[, ...])	Get a circular contour diameter of the axon population
expand_pop(y_axons, z_axons, factor)	Expand population of placed axons by a specified number
remove_collision(axons_diameters, y_axons, ...)	Remove collinding axons in a population
remove_outlier_axons(axons_diameters, ...[, ...])	Remove axons in a population located outside a circular border, defined by its diameter
load_stat(stat_name)	Load a statistic stored in the included librairy or specified by the user in a csv file (first corlumn: axon diameter bin start - second corlumn: proportion)
create_axon_population(N[, percent_unmyel, ...])	Create a virtual population of axons (no Neuron implementation, axon class not called) of a controled number, with controlled statistics.
fill_area_with_axons(A[, percent_unmyel, ...])	Create a virtual population of axons (no Neuron implementation, axon class not called) to fill a specified area, with controlled statistics.
plot_population(diameters, y_axons, z_axons, ...)	Display a population of axons.
save_axon_population(f_name, ...[, y_axons, ...])	Save a placed axonal population to a file
load_axon_population(f_name)	Load a placed population from a file