NEURON
Public Member Functions | Public Attributes | List of all members
coreneuron::CellMapping Struct Reference

Compartment mapping information for a cell. More...

#include <nrnsection_mapping.hpp>

Public Member Functions

 CellMapping (int g)
 
int num_sections () const
 total number of sections in a cell More...
 
int num_compartments () const
 return number of compartments in a cell More...
 
size_t num_electrodes () const
 return the total number of electrodes More...
 
size_t size () const noexcept
 number of section lists More...
 
void add_sec_map (std::shared_ptr< SecMapping > s)
 add new SecMapping More...
 
std::shared_ptr< SecMapping > get_seclist_mapping (const SectionType type) const
 return section list mapping with given type More...
 
size_t get_seclist_compartment_count (const SectionType type) const
 return compartment count for specific section list with given type More...
 
size_t get_seclist_section_count (const SectionType type) const
 return segment count for specific section list with given type More...
 
void add_segment_lfp_factor (const int segment_id, std::vector< double >::const_iterator begin, std::vector< double >::const_iterator end)
 add the lfp electrode factors of a segment_id More...
 

Public Attributes

int gid
 gid of a cell More...
 
std::vector< std::shared_ptr< SecMapping > > sec_mappings
 list of section lists (like soma, axon, apic) More...
 
std::vector< int > lfp_segment_ids
 segment ids for lfp factors (one per compartment with LFP data) More...
 
std::vector< double > lfp_factors_flat
 flat array of lfp factors: stride = num_electrodes, indexed as [i * stride + e] More...
 
std::vector< size_t > electrode_offsets
 Electrode offsets per LFP report (CSR-style, size = num_reports + 1). More...
 

Detailed Description

Compartment mapping information for a cell.

A cell can have multiple section list types like soma, axon, apic, dend etc. User will add these section lists using HOC interface.

Definition at line 70 of file nrnsection_mapping.hpp.

Constructor & Destructor Documentation

◆ CellMapping()

coreneuron::CellMapping::CellMapping ( int  g)
inline

Definition at line 87 of file nrnsection_mapping.hpp.

Member Function Documentation

◆ add_sec_map()

void coreneuron::CellMapping::add_sec_map ( std::shared_ptr< SecMapping >  s)
inline

add new SecMapping

Definition at line 121 of file nrnsection_mapping.hpp.

◆ add_segment_lfp_factor()

void coreneuron::CellMapping::add_segment_lfp_factor ( const int  segment_id,
std::vector< double >::const_iterator  begin,
std::vector< double >::const_iterator  end 
)
inline

add the lfp electrode factors of a segment_id

Definition at line 155 of file nrnsection_mapping.hpp.

◆ get_seclist_compartment_count()

size_t coreneuron::CellMapping::get_seclist_compartment_count ( const SectionType  type) const
inline

return compartment count for specific section list with given type

Definition at line 138 of file nrnsection_mapping.hpp.

◆ get_seclist_mapping()

std::shared_ptr<SecMapping> coreneuron::CellMapping::get_seclist_mapping ( const SectionType  type) const
inline

return section list mapping with given type

Definition at line 126 of file nrnsection_mapping.hpp.

◆ get_seclist_section_count()

size_t coreneuron::CellMapping::get_seclist_section_count ( const SectionType  type) const
inline

return segment count for specific section list with given type

Definition at line 146 of file nrnsection_mapping.hpp.

◆ num_compartments()

int coreneuron::CellMapping::num_compartments ( ) const
inline

return number of compartments in a cell

Definition at line 101 of file nrnsection_mapping.hpp.

◆ num_electrodes()

size_t coreneuron::CellMapping::num_electrodes ( ) const
inline

return the total number of electrodes

Definition at line 111 of file nrnsection_mapping.hpp.

◆ num_sections()

int coreneuron::CellMapping::num_sections ( ) const
inline

total number of sections in a cell

Definition at line 91 of file nrnsection_mapping.hpp.

◆ size()

size_t coreneuron::CellMapping::size ( ) const
inlinenoexcept

number of section lists

Definition at line 116 of file nrnsection_mapping.hpp.

Member Data Documentation

◆ electrode_offsets

std::vector<size_t> coreneuron::CellMapping::electrode_offsets

Electrode offsets per LFP report (CSR-style, size = num_reports + 1).

offsets[i]..offsets[i+1] gives the electrode range for report i.

Definition at line 85 of file nrnsection_mapping.hpp.

◆ gid

int coreneuron::CellMapping::gid

gid of a cell

Definition at line 72 of file nrnsection_mapping.hpp.

◆ lfp_factors_flat

std::vector<double> coreneuron::CellMapping::lfp_factors_flat

flat array of lfp factors: stride = num_electrodes, indexed as [i * stride + e]

Definition at line 81 of file nrnsection_mapping.hpp.

◆ lfp_segment_ids

std::vector<int> coreneuron::CellMapping::lfp_segment_ids

segment ids for lfp factors (one per compartment with LFP data)

Definition at line 78 of file nrnsection_mapping.hpp.

◆ sec_mappings

std::vector<std::shared_ptr<SecMapping> > coreneuron::CellMapping::sec_mappings

list of section lists (like soma, axon, apic)

Definition at line 75 of file nrnsection_mapping.hpp.

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