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 ~ActivationFunction ()=default
 Virtual destructor.
void set_param (const std::string &name, double value)
 Set a scalar parameter value by name.
virtual void finalize ()
 Called after all parameters are set (e.g. by loader).

Additional Inherited Members

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

Detailed Description

Wrapping cosine activation function.

Reproduces the atrial activation AA(t) from [9] 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: