RatioBasedFamilies Class Reference

Generator which does a random assignment of locations to family IDs. More...

#include <RatioBasedFamilies.h>

Inheritance diagram for RatioBasedFamilies:

Inheritance graph
[legend]
Collaboration diagram for RatioBasedFamilies:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 RatioBasedFamilies (vector< double > const &ratios)
 Initialize a SpatialFamilyIDGenerator.
virtual shared_ptr< vector
< familyid_t > > 
generateIDs (SimNetwork &net, vector< SimObjectFactory * > const &families, Point3DSet const &locs) const
 Return for each location a family id.


Detailed Description

Generator which does a random assignment of locations to family IDs.

Implements the interface SpatialFamilyIDGenerator for merging families of neurons in one population. Each family has a assigned probabiliteis of occurence in the population. Probabilities can be given as ratios, which are then normalized such that they sum up to 1.

Definition at line 26 of file RatioBasedFamilies.h.


Constructor & Destructor Documentation

RatioBasedFamilies::RatioBasedFamilies ( vector< double > const &  ratios  ) 

Initialize a SpatialFamilyIDGenerator.

Definition at line 18 of file RatioBasedFamilies.cpp.


Member Function Documentation

shared_ptr< vector< familyid_t > > RatioBasedFamilies::generateIDs ( SimNetwork net,
vector< SimObjectFactory * > const &  families,
Point3DSet const &  locs 
) const [virtual]

Return for each location a family id.

Reimplemented from SpatialFamilyIDGenerator.

Definition at line 40 of file RatioBasedFamilies.cpp.

References RandomDistributionBoostImplementation< boost_dist >::get(), SimNetwork::getMainConstructRNGEngine(), and Point3DSet::size().

Here is the call graph for this function:


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

Generated on Wed Jul 9 16:34:52 2008 for PCSIM by  doxygen 1.5.5