Cypress  1.0
C++ Spiking Neural Network Simulation Framework
Public Member Functions | Protected Member Functions | List of all members
cypress::transformations::IFFH1UnitScale Class Reference

#include <spikey_if_cond_exp.hpp>

Inheritance diagram for cypress::transformations::IFFH1UnitScale:
Inheritance graph
[legend]
Collaboration diagram for cypress::transformations::IFFH1UnitScale:
Collaboration graph
[legend]

Public Member Functions

std::string id () const override
 
 ~IFFH1UnitScale ()
 
virtual TransformationProperties properties () const
 
NetworkBase transform (const NetworkBase &src, TransformationAuxData &aux)
 
void copy_results (const NetworkBase &src, NetworkBase &tar) const
 

Protected Member Functions

NetworkBase do_transform (const NetworkBase &src, TransformationAuxData &aux) override
 
virtual void do_copy_results (const NetworkBase &src, NetworkBase &tar) const
 

Detailed Description

Adapts the Spikey neuron parameter unit scales – for spikey, g_leak is measured in nS, whereas it is measured uS in all other simulations. This transformation takes care of this discrepancy.

Constructor & Destructor Documentation

cypress::transformations::IFFH1UnitScale::~IFFH1UnitScale ( )
inline

Member Function Documentation

void cypress::Transformation::copy_results ( const NetworkBase src,
NetworkBase tar 
) const
inherited

Copys the results from a transformed network to the original network.

virtual void cypress::Transformation::do_copy_results ( const NetworkBase src,
NetworkBase tar 
) const
protectedvirtualinherited

Function called after the network was executed. This function should copy recorded data from the actually executed network to the target network. This function must be overriden if the network topology (including the neuron type) was changed by the transformation. Otherwise a default implementation is used.

NetworkBase cypress::transformations::IFFH1UnitScale::do_transform ( const NetworkBase src,
TransformationAuxData aux 
)
overrideprotectedvirtual

Function which should be overriden by child classes. This function should perform the actual transformation an remember which changes were done.

Parameters
srcis the network which should be modified.
Returns
is a new Network instance which contains the transformed data.

Implements cypress::Transformation.

std::string cypress::transformations::IFFH1UnitScale::id ( ) const
inlineoverridevirtual

Returns an id which can for example be used to explicitly disable certain transformations.

Returns
a unique ID describing this transformation.

Implements cypress::Transformation.

virtual TransformationProperties cypress::Transformation::properties ( ) const
inlinevirtualinherited

Returns a structure describing the transformation, e.g. whether it is lossy or the priority with which it should be applied.

Returns
an instance of Transformation properties which contains information about this particular transformation.

Reimplemented in cypress::transformations::LIFToIFFH1.

NetworkBase cypress::Transformation::transform ( const NetworkBase src,
TransformationAuxData aux 
)
inherited

Performs the transformation on the given network instance.

Parameters
srcis the network which should be modified.
auxis some auxiliary data which may be modified by the transformation.
Returns
is a new Network instance which contains the transformed data.

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