Circuit Explorer API

This page references the loaders and entrypoints registered by the Circuit Explorer plugin.

Loaders

Cell placement loader

Can load the following formats: circuit.morphologies.h5.

This loader does not support loading binary data using ‘upload-model’.

type	object
properties
extension	Morphology file extension
	type	string
ids	IDs of the nodes to load (overrides percentage)
	type	array
	items	type	integer
		minimum	0
morphology_folder	Path to morphology folder
	type	string
morphology_parameters	NeuronMorphologyLoaderParameters
	Settings for morphology geometry loading
	type	object
	default
	properties
	geometry_type	Geometry generation configuration
		type	string
		enum	original, smooth, section_smooth, constant_radii, spheres
		default	smooth
	load_axon	Load the axon section of the neuron
		type	boolean
		default	False
	load_dendrites	Load the dendrites section of the neuron
		type	boolean
		default	False
	load_soma	Load the soma section of the neuron
		type	boolean
		default	False
	radius_multiplier	Parameter to multiply all morphology sample radii by
		type	number
		minimum	0.1
		default	1
	resampling	Minimum angle cosine between 2 segments to merge them (disabled if > 1)
		type	number
		default	2
	subsampling	Skip factor when converting samples into geometry (disabled if <= 1)
		type	integer
		minimum	0
		default	1
	additionalProperties	False
percentage	Percentage of cells to load
	type	number
	maximum	1
	minimum	0
	default	1
additionalProperties	False

---

Neuron Morphology loader

Can load the following formats: swc, h5, asc.

This loader does not support loading binary data using ‘upload-model’.

type	object
properties
geometry_type	Geometry generation configuration
	type	string
	enum	original, smooth, section_smooth, constant_radii, spheres
	default	smooth
load_axon	Load the axon section of the neuron
	type	boolean
	default	False
load_dendrites	Load the dendrites section of the neuron
	type	boolean
	default	False
load_soma	Load the soma section of the neuron
	type	boolean
	default	False
radius_multiplier	Parameter to multiply all morphology sample radii by
	type	number
	minimum	0.1
	default	1
resampling	Minimum angle cosine between 2 segments to merge them (disabled if > 1)
	type	number
	default	2
subsampling	Skip factor when converting samples into geometry (disabled if <= 1)
	type	integer
	minimum	0
	default	1
additionalProperties	False

---

SONATA loader

Can load the following formats: .json.

This loader does not support loading binary data using ‘upload-model’.

type	object
properties
node_population_settings	List of node populations to load and their settings
	type	array
	items	SonataNodePopulationParameters
		type	object
		properties
		edge_populations	List of edge populations to load and their settings
			type	array
			items	SonataEdgePopulationParameters
				type	object
				properties
				edge_percentage	Percentage of edges to load from all available
					type	number
					maximum	1
					minimum	0
					default	1
				edge_population	Name of the edge population to load
					type	string
				edge_report_name	Name of a synapse report to load along the edge population
					type	string
				load_afferent	Wether to load afferent or efferent edges
					type	boolean
				radius	Radius used for the synapse sphere geometry (Ignored for endfeet)
					type	number
					minimum	0.1
					default	2
				additionalProperties	False
		neuron_morphology_parameters	NeuronMorphologyLoaderParameters
			Settings for morphology geometry loading (ignored for vasculature populations)
			type	object
			default
			properties
			geometry_type	Geometry generation configuration
				type	string
				enum	original, smooth, section_smooth, constant_radii, spheres
				default	smooth
			load_axon	Load the axon section of the neuron
				type	boolean
				default	False
			load_dendrites	Load the dendrites section of the neuron
				type	boolean
				default	False
			load_soma	Load the soma section of the neuron
				type	boolean
				default	False
			radius_multiplier	Parameter to multiply all morphology sample radii by
				type	number
				minimum	0.1
				default	1
			resampling	Minimum angle cosine between 2 segments to merge them (disabled if > 1)
				type	number
				default	2
			subsampling	Skip factor when converting samples into geometry (disabled if <= 1)
				type	integer
				minimum	0
				default	1
			additionalProperties	False
		node_count_limit	Maximum number of nodes to load
			type	integer
			minimum	0
		node_ids	List of node IDs to load (invalidates ‘node_percentage’ and ‘node_sets’)
			type	array
			items	type	integer
				minimum	0
		node_percentage	Percentage of nodes to load (after nodeset filter) (ignored if node_ids is provided)
type			number
maximum			1
minimum	0
default	0.01
node_population	Name of the node population to load
	type	string
node_sets	List of node set names/regex to filter the node population (ignored if node_ids is provided)
	type	array
	items	type	string
report_name	Name of the report file to load (ignored if report_type is ‘none’ or ‘spikes’)
	type	string
report_type	Type of report to load for the given node population
	type	string
	enum	none, spikes, compartment, summation, synapse, bloodflow_pressure, bloodflow_speed, bloodflow_radii
	default	none
spike_transition_time	When loading a spike report, fade-in/out time [ms], from resting to spike state.
	type	number
	minimum	0
	default	1
vasculature_geometry_parameters	VasculatureGeometrySettings
	Settings for vasculature geometry load (ignored for any non-vasculature population
	type	object
	default
	properties
	radius_multiplier	Factor to multiply all vasculature sample radii
		type	number
		minimum	0.1
		default	1
	additionalProperties	False
additionalProperties	False
additionalProperties	False

Entrypoints

get-circuit-ids

For neuron/astrocyte/vasculature models, return the list of ids loaded.

Params:

type	object
properties
model_id	ID of the model to query
	type	integer
	minimum	0
additionalProperties	False

Result:

type	array
items	type	integer
	minimum	0

---

set-circuit-thickness

Modify the geometry radiuses (spheres, cones, cylinders and SDF geometries).

Params:

type	object
properties
model_id	ID of the circuit model
	type	integer
	minimum	0
radius_multiplier	Scaling factor
	type	number
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.