Placeholders config file

Schema

The config passed to the Placeholder workflow should follow the following schema:

Config file schema

Description of the config file format.
type	array
items	type	object
	properties
	populations	type	array
		items	type	object
			properties
			name	The name used for this population when the aggregation mode is set to ‘population’.
				type	string
				default	__aggregated_population__
			region	The name of the region used to select the morphologies (can be set to null to take the morphologies of all regions).
				type	string
			mtype	The name of the mtype used to select the morphologies (can be set to null to take the morphologies of all mtypes).
				type	string
			mode	The aggregation mode.
				type	string
				enum	morphology, population
				default	morphology
			additionalProperties	False
	config	type	object
		properties
		<feature type>	The type of the NeuroM feature (can be ‘neurite’, ‘morphology’ or ‘population’).
			type	object
			properties
			<feature name>	The name of the NeuroM feature (see the NeuroM documentation).
				type	object
				properties
				kwargs	type	array
					items	type	object
						properties
						<kwarg name>	The name and value of this entry are the kwarg name and value.
				modes	type	array
					items	The name of aggregation mode.
						type	string
						enum	min, max, mean, sum
		neurite_type	The neurite types used to filter the neurites.
			type	array
			enum	AXON, BASAL_DENDRITE, APICAL_DENDRITE, ALL
			items	type	string

Here is an example of a simple configuration file:

Example

 1 [
 2     {
 3         "populations": [
 4             {
 5                 "region": "Region example",
 6                 "mtype": "Mtype example",
 7                 "name": "Population example"
 8             }
 9         ],
10         "config": {
11             "neurite": {
12                 "aspect_ratio": {
13                     "kwargs": [
14                         {"projection_plane": "xy"},
15                     ],
16                     "modes": ["mean"],
17                 },
18                 "length_fraction_above_soma": {
19                     "kwargs": [{"up": "X"}, {"up": "Y"}, {"up": "Z"}],
20                     "modes": ["mean"],
21                 },
22                 "total_height": {"modes": ["max"]},
23                 "total_length": {"modes": ["sum"]},
24             },
25             "morphology": {
26                 "soma_radius": {"modes": ["mean"]},
27                 "soma_surface_area": {"modes": ["mean"]}
28             },
29             "neurite_type": ["AXON", "APICAL_DENDRITE", "BASAL_DENDRITE"]
30         }
31     }
32 ]