MOOSE - Multiscale Object Oriented Simulation Environment
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
SwcBranch Class Reference

#include <SwcSegment.h>

+ Inheritance diagram for SwcBranch:
+ Collaboration diagram for SwcBranch:

Public Member Functions

void printDiagnostics () const
 
 SwcBranch (int i, const SwcSegment &start, double len, double L, const vector< int > &cable)
 
- Public Member Functions inherited from SwcSegment
void addChild (unsigned int kid)
 
double distance (const SwcSegment &other) const
 
void figureOutType ()
 
double getElecDistFromSoma () const
 
double getGeomDistFromSoma () const
 
double getPathDistFromSoma () const
 
const vector< int > & kids () const
 
double L () const
 
double length () const
 
unsigned int myIndex () const
 
bool OK () const
 
unsigned int parent () const
 
double radius () const
 
void replaceKids (const vector< int > &kids)
 
void setBad ()
 
void setCumulativeDistance (double len, double L, double pSoma, double eSoma)
 
void setGeometricalDistanceFromSoma (const SwcSegment &soma)
 
void setParent (unsigned int pa)
 
 SwcSegment ()
 
 SwcSegment (const string &line)
 
 SwcSegment (int i, short type, double x, double y, double z, double r, int parent)
 
unsigned short type () const
 
const Vecvec () const
 

Public Attributes

double electroLength
 
double geomLength
 Radius at end. More...
 
double pathLength
 Geometrical length of entire branch, summed along all segments. More...
 
double r0
 
double r1
 Radius at beginning. More...
 
vector< int > segs_
 

Additional Inherited Members

- Static Public Attributes inherited from SwcSegment
static const short APICAL = 4
 
static const short APICAL_END = 13
 
static const short APICAL_FORK = 12
 
static const short AXON = 2
 
static const short AXON_END = 11
 
static const short AXON_FORK = 10
 
static const short BadSegment = 8
 
static const short CUSTOM = 7
 
static const short DEND = 3
 
static const short END = 6
 
static const short FORK = 5
 
static const short SOMA = 1
 
static const string typeName []
 
static const short UNDEF = 0
 
- Protected Attributes inherited from SwcSegment
double electrotonicDistanceFromSoma_
 electrotonic dist from soma, summed along dend. More...
 
double geometricalDistanceFromSoma_
 geometrical distance from soma. More...
 
vector< int > kids_
 
double L_
 Length of segment. More...
 
double length_
 Radius of segment. More...
 
unsigned int myIndex_
 
unsigned int parent_
 Number of length constants in segment. More...
 
double pathDistanceFromSoma_
 Index of parent. Is ~0 for soma. More...
 
double radius_
 coordinates of end of segment More...
 
short type_
 Index of self. More...
 
Vec v_
 

Detailed Description

Definition at line 172 of file SwcSegment.h.

Constructor & Destructor Documentation

SwcBranch::SwcBranch ( int  i,
const SwcSegment start,
double  len,
double  L,
const vector< int > &  cable 
)

Definition at line 112 of file SwcSegment.cpp.

References SwcSegment::kids_, SwcSegment::myIndex_, SwcSegment::parent_, and segs_.

114  : SwcSegment( start ),
115  r0( start.radius() ),
116  r1( start.radius() ),
117  geomLength( len ),
118  electroLength( L )
119 {
120  myIndex_ = i;
121  parent_ = 0;
122  kids_.resize( 0 );
123  segs_.resize( cable.size() );
124  // Put the contents of cable into segs, in reverse order.
125  vector< int >::const_reverse_iterator j = cable.rbegin();
126  vector< int >::iterator k = segs_.begin();
127  for ( k = segs_.begin(); k != segs_.end(); ++k )
128  *k = *j++;
129 }
vector< int > segs_
Definition: SwcSegment.h:202
double L() const
Definition: SwcSegment.h:83
double geomLength
Radius at end.
Definition: SwcSegment.h:184
double electroLength
Definition: SwcSegment.h:195
unsigned int myIndex_
Definition: SwcSegment.h:140
vector< int > kids_
Definition: SwcSegment.h:169
double r0
Definition: SwcSegment.h:180
double radius() const
Definition: SwcSegment.h:76
double r1
Radius at beginning.
Definition: SwcSegment.h:181
unsigned int parent_
Number of length constants in segment.
Definition: SwcSegment.h:158

Member Function Documentation

void SwcBranch::printDiagnostics ( ) const

Definition at line 131 of file SwcSegment.cpp.

References electroLength, geomLength, SwcSegment::myIndex(), SwcSegment::parent(), and segs_.

132 {
133  cout << myIndex() << ": " << segs_[0] << " -> " << segs_.back() <<
134  " = " << segs_.size() <<
135  " : pa = " << parent() << " , length=( " <<
136  geomLength << ", " << electroLength << " )\n";
137 }
vector< int > segs_
Definition: SwcSegment.h:202
unsigned int parent() const
Definition: SwcSegment.h:44
double geomLength
Radius at end.
Definition: SwcSegment.h:184
unsigned int myIndex() const
Definition: SwcSegment.h:52
double electroLength
Definition: SwcSegment.h:195

+ Here is the call graph for this function:

Member Data Documentation

double SwcBranch::electroLength

Electrotonic length summed along all branch segments. This does not include the assumed constant RA and RA terms, those are treated as 1.0. Suitable post-facto scaling needed.

Definition at line 195 of file SwcSegment.h.

Referenced by printDiagnostics().

double SwcBranch::geomLength

Radius at end.

Geometrical length of dendrite from soma

Definition at line 184 of file SwcSegment.h.

Referenced by printDiagnostics().

double SwcBranch::pathLength

Geometrical length of entire branch, summed along all segments.

Definition at line 187 of file SwcSegment.h.

double SwcBranch::r0

Definition at line 180 of file SwcSegment.h.

double SwcBranch::r1

Radius at beginning.

Definition at line 181 of file SwcSegment.h.

vector< int > SwcBranch::segs_

segs: ist of segments, in order away from soma. The starting entry is the one after the fork point. The last entry is either a fork or an end point.

Definition at line 202 of file SwcSegment.h.

Referenced by ReadSwc::build(), printDiagnostics(), and SwcBranch().


The documentation for this class was generated from the following files: