pygrenade_vx.network.Neuron

class pygrenade_vx.network.Neuron

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)

Overloaded function.

__init__(self: _pygrenade_vx_network.Neuron) -> None
__init__(self: _pygrenade_vx_network.Neuron, arg0: _pygrenade_vx_network.Neuron) -> None

Methods

`__init__`(args, *kwargs)	Overloaded function.
`add_compartment`(self, compartment)
`add_compartment_connection`(self, source, …)
`adjacent_compartments`(self, descriptor)
`compartment_connection_iterators`(self)
`compartment_iterators`(self)
`compartments_connected`(self)
`contains`(self, descriptor)
`get`(args, *kwargs)	Overloaded function.
`get_compartment_index_map`(self)
`in_degree`(self, descriptor)
`isomorphism`(self, other)	Return mapping of compartments between this and other neuron.
`neighbour`(self, source, target)
`num_compartment_connections`(self)
`num_compartments`(self)
`out_degree`(self, descriptor)
`remove_compartment`(self, descriptor)
`remove_compartment_connection`(self, descriptor)
`set`(args, *kwargs)	Overloaded function.
`source`(self, descriptor)
`target`(self, descriptor)
`valid`(self)

add_compartment(self: _pygrenade_vx_network.Neuron, compartment: _pygrenade_vx_network.Compartment) → _pygrenade_vx_network.CompartmentOnNeuron

add_compartment_connection(self: _pygrenade_vx_network.Neuron, source: _pygrenade_vx_network.CompartmentOnNeuron, target: _pygrenade_vx_network.CompartmentOnNeuron, edge: _pygrenade_vx_network.CompartmentConnection) → _pygrenade_vx_network.CompartmentConnectionOnNeuron

adjacent_compartments(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron) → tuple[boost::iterators::transform_iterator<grenade::common::detail::ConstructorTransform<grenade::vx::network::abstract::CompartmentOnNeuron>, boost::adjacency_iterator<boost::adjacency_list<boost::setS, boost::listS, boost::undirectedS, boost::no_property, boost::no_property, boost::no_property, boost::listS>, void*, boost::detail::out_edge_iter<std::_Rb_tree_const_iterator<boost::detail::stored_edge_iter<void*, std::_List_iterator<boost::list_edge<void*, boost::no_property> >, boost::no_property> >, void*, boost::detail::edge_desc_impl<boost::undirected_tag, void*>, long>, long>, boost::use_default, boost::use_default>, boost::iterators::transform_iterator<grenade::common::detail::ConstructorTransform<grenade::vx::network::abstract::CompartmentOnNeuron>, boost::adjacency_iterator<boost::adjacency_list<boost::setS, boost::listS, boost::undirectedS, boost::no_property, boost::no_property, boost::no_property, boost::listS>, void*, boost::detail::out_edge_iter<std::_Rb_tree_const_iterator<boost::detail::stored_edge_iter<void*, std::_List_iterator<boost::list_edge<void*, boost::no_property> >, boost::no_property> >, void*, boost::detail::edge_desc_impl<boost::undirected_tag, void*>, long>, long>, boost::use_default, boost::use_default>]

compartment_connection_iterators(self: _pygrenade_vx_network.Neuron) → tuple[boost::iterators::transform_iterator<grenade::common::detail::ConstructorTransform<grenade::vx::network::abstract::CompartmentConnectionOnNeuron>, boost::detail::undirected_edge_iter<std::_List_iterator<boost::list_edge<void*, boost::no_property> >, boost::detail::edge_desc_impl<boost::undirected_tag, void*>, long>, boost::use_default, boost::use_default>, boost::iterators::transform_iterator<grenade::common::detail::ConstructorTransform<grenade::vx::network::abstract::CompartmentConnectionOnNeuron>, boost::detail::undirected_edge_iter<std::_List_iterator<boost::list_edge<void*, boost::no_property> >, boost::detail::edge_desc_impl<boost::undirected_tag, void*>, long>, boost::use_default, boost::use_default>]

compartment_iterators(self: _pygrenade_vx_network.Neuron) → tuple[boost::iterators::transform_iterator<grenade::common::detail::ConstructorTransform<grenade::vx::network::abstract::CompartmentOnNeuron>, std::_List_iterator<void*>, boost::use_default, boost::use_default>, boost::iterators::transform_iterator<grenade::common::detail::ConstructorTransform<grenade::vx::network::abstract::CompartmentOnNeuron>, std::_List_iterator<void*>, boost::use_default, boost::use_default>]

contains(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron) → bool

get(*args, **kwargs)

Overloaded function.

get(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron) -> _pygrenade_vx_network.Compartment
get(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentConnectionOnNeuron) -> _pygrenade_vx_network.CompartmentConnection

get_compartment_index_map(self: _pygrenade_vx_network.Neuron) → dict[capsule, int]

in_degree(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron) → int

isomorphism(self: _pygrenade_vx_network.Neuron, other: _pygrenade_vx_network.Neuron) → dict[_pygrenade_vx_network.CompartmentOnNeuron, _pygrenade_vx_network.CompartmentOnNeuron]: Return mapping of compartments between this and other neuron. If no mapping between all the neurons compartments is possible an map with the possible compartment mappings is returned.

neighbour(self: _pygrenade_vx_network.Neuron, source: _pygrenade_vx_network.CompartmentOnNeuron, target: _pygrenade_vx_network.CompartmentOnNeuron) → bool

out_degree(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron) → int

remove_compartment(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron) → None

remove_compartment_connection(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentConnectionOnNeuron) → None

set(*args, **kwargs)

Overloaded function.

set(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentOnNeuron, compartment: _pygrenade_vx_network.Compartment) -> None
set(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentConnectionOnNeuron, connection: _pygrenade_vx_network.CompartmentConnection) -> None

source(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentConnectionOnNeuron) → _pygrenade_vx_network.CompartmentOnNeuron

target(self: _pygrenade_vx_network.Neuron, descriptor: _pygrenade_vx_network.CompartmentConnectionOnNeuron) → _pygrenade_vx_network.CompartmentOnNeuron