Module pypcsim :: Class SpatialFamilyPopulation
[hide private]
[frames] | no frames]

Class SpatialFamilyPopulation

        object --+            
                 |            
       ??.instance --+        
                     |        
   SimObjectPopulation --+    
                         |    
SpatialSimObjectPopulation --+
                             |
                            SpatialFamilyPopulation
Known Subclasses:

Help on SpatialFamilyPopulation [class]:
 This class associates a family ID and a location in 3D space with each simulation object in the population 
 
Extends the basic population concept by associating a \b location \b in \b 3D \b space 
(double triples) to each simobject in the population, as well as one integer attribute 
named as \b family \b ID. 
 
For construction, an array of SimObjectFactories is provided where each SimObjectFactory 
defines one family of simulation objects. The SpatialFamilyIDGenerator chooses among the 
factoriesfamilies at each object creation step which is carried out for each location 
in the Point3DSet. 
 
The family ID indicates the index of the SimObjectFactory that was 
used to create the particular object (useful for designating excitatory, 
inhibitory and other families of neurons). 
 
Individual objects and their ID can be accessed by their index (integer or integer tuple) or 
by their location in space. 
 
Also, subpopulations can be created by providing a subspace definitions, and based on family IDs.

Instance Methods [hide private]
 
__init__(...)
Help on SpatialFamilyPopulation::SpatialFamilyPopulation(SimNetwork & net, std::vector<SimObjectFactory*, std::allocator<SimObjectFactory*> > const & families, SpatialFamilyIDGenerator const & fidgen, boost::shared_ptr<Point3DSet> locs) [constructor]
 
getFamilyID(...)
Help on familyid_t SpatialFamilyPopulation::getFamilyID(size_t index) [member function]
 
getFamilyIdAt(...)
Help on familyid_t SpatialFamilyPopulation::getFamilyIdAt(Point3D<double> const & p) [member function]
 
setFamilyID(...)
Help on void SpatialFamilyPopulation::setFamilyID(familyid_t newID) [member function]
 
splitFamilies(...)
 
subPopulation(...)

Inherited from SpatialSimObjectPopulation: getIdAt, getLocation, objectAt

Inherited from SimObjectPopulation: __call__, __getitem__, getID, getNet, idVector, localIndexes, localSubPopulation, object, record, setFieldScale, size, subset

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  __instance_size__ = 48
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Help on SpatialFamilyPopulation::SpatialFamilyPopulation(SimNetwork & net, std::vector<SimObjectFactory*, std::allocator<SimObjectFactory*> > const & families, SpatialFamilyIDGenerator const & fidgen, boost::shared_ptr<Point3DSet> locs) [constructor]

Help on SpatialFamilyPopulation::SpatialFamilyPopulation(SimNetwork & net, std::vector<boost::shared_ptr<SimObjectFactory>,std::allocator<boost::shared_ptr<SimObjectFactory> > > const & families, SpatialFamilyIDGenerator const & fidgen, boost::shared_ptr<Point3DSet> locs) [constructor]

Help on SpatialFamilyPopulation::SpatialFamilyPopulation(SimNetwork & net, SimObjectFactory * fam0, boost::shared_ptr<Point3DSet> locs) [constructor]

Help on SpatialFamilyPopulation::SpatialFamilyPopulation(std::vector<boost::shared_ptr<SpatialFamilyPopulation>,std::allocator<boost::shared_ptr<SpatialFamilyPopulation> > > const & pops) [constructor]

Overrides: object.__init__

getFamilyIdAt(...)

 

Help on familyid_t SpatialFamilyPopulation::getFamilyIdAt(Point3D<double> const & p) [member function]

Help on familyid_t SpatialFamilyPopulation::getFamilyIdAt(double const & x, double const & y, double const & z) [member function]

subPopulation(...)

 
Overrides: SpatialSimObjectPopulation.subPopulation