svZeroDSolver
Loading...
Searching...
No Matches
WrappingCosineActivation Class Reference

Wrapping cosine activation function. More...

#include <ActivationFunction.h>

Inheritance diagram for WrappingCosineActivation:
[legend]

Public Member Functions

 WrappingCosineActivation (double cardiac_period)
 Construct a new WrappingCosineActivation object.
double compute (double time) override
 Compute activation value at given time.
Public Member Functions inherited from ActivationFunction
 ActivationFunction (double cardiac_period, const std::vector< std::pair< std::string, InputParameter > > &input_param_properties)
 Construct activation function.
virtual ActivationSignalType signal_type () const
 Type of signal this activation function's compute() produces.
Public Member Functions inherited from ParameterHolder
 ParameterHolder (const std::vector< std::pair< std::string, InputParameter > > &props)
 Construct a ParameterHolder.
void set_param (const std::string &name, double value)
 Set a scalar parameter value by name.
void set_param_vector (const std::string &name, const std::vector< double > &value)
 Set a vector-valued parameter value by name.
virtual void finalize ()
 Called once after all parameters have been read from the input file (e.g. by the loader).

Additional Inherited Members

Static Public Member Functions inherited from ActivationFunction
static std::unique_ptr< ActivationFunction > create_default (const std::string &type_str, double cardiac_period)
 Create a default activation function from activation function type.
Public Attributes inherited from ParameterHolder
const std::vector< std::pair< std::string, InputParameter > > input_param_properties
 Properties of the input parameters for this component [(name, InputParameter), ...].
Protected Attributes inherited from ActivationFunction
double cardiac_period_
 Time duration of one cardiac cycle.
Protected Attributes inherited from ParameterHolder
std::map< std::string, double > params_
 Map of scalar parameter names to their values.
std::map< std::string, std::vector< double > > params_vec_
 Map of vector-valued parameter names to their values.

Detailed Description

Wrapping cosine activation function.

Reproduces the atrial activation AA(t) from [10] and [5]. The cosine wraps across the cardiac cycle boundary, which half_cosine and piecewise_cosine cannot do.

Parameters:

  • Tsa — Atrial systole time fraction (multiplied by cardiac period)
  • tpwave — P-wave divisor (cardiac period is divided by this)

Constructor & Destructor Documentation

◆ WrappingCosineActivation()

WrappingCosineActivation::WrappingCosineActivation ( double cardiac_period)
inlineexplicit

Construct a new WrappingCosineActivation object.

Parameters
cardiac_periodCardiac cycle period

Member Function Documentation

◆ compute()

double WrappingCosineActivation::compute ( double time)
overridevirtual

Compute activation value at given time.

Parameters
timeCurrent time
Returns
Activation value between 0 and 1

Implements ActivationFunction.


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