Section to segment mapping. More...

#include <nrnsection_mapping.hpp>

Public Member Functions
	SecMapping ()=default

	SecMapping (SectionType t)

size_t	num_sections () const noexcept
	return total number of sections in section list More...

size_t	num_compartments () const
	return number of compartments in section list More...

void	add_segment (int sec, int seg)
	add section to associated segment More...

Public Attributes
SectionType	type
	name of section list More...

std::unordered_map< int, std::vector< int > >	secmap
	map of section and associated compartments More...

Detailed Description

Section to segment mapping.

For a section list (of a particulat type), store mapping of section to compartments a section is a arbitrary user classification to recognize some compartments (ex: api, soma, dend, axon)

Definition at line 33 of file nrnsection_mapping.hpp.

Constructor & Destructor Documentation

◆ SecMapping() [1/2]

coreneuron::SecMapping::SecMapping ( )

default

◆ SecMapping() [2/2]

coreneuron::SecMapping::SecMapping ( SectionType t )

inlineexplicit

Definition at line 42 of file nrnsection_mapping.hpp.

Member Function Documentation

◆ add_segment()

void coreneuron::SecMapping::add_segment	(	int	sec,
		int	seg
	)

inline

add section to associated segment

Definition at line 58 of file nrnsection_mapping.hpp.

◆ num_compartments()

size_t coreneuron::SecMapping::num_compartments ( ) const

inline

return number of compartments in section list

Definition at line 51 of file nrnsection_mapping.hpp.

◆ num_sections()

size_t coreneuron::SecMapping::num_sections ( ) const

inlinenoexcept

return total number of sections in section list

Definition at line 46 of file nrnsection_mapping.hpp.

Member Data Documentation

◆ secmap

std::unordered_map<int, std::vector<int> > coreneuron::SecMapping::secmap

map of section and associated compartments

Definition at line 38 of file nrnsection_mapping.hpp.

◆ type

SectionType coreneuron::SecMapping::type

name of section list

Definition at line 35 of file nrnsection_mapping.hpp.

The documentation for this struct was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/nrn/checkouts/3468/src/coreneuron/io/nrnsection_mapping.hpp

Public Member Functions

Public Attributes