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

Piecewise cosine activation function. More...

#include <ActivationFunction.h>

Inheritance diagram for PiecewiseCosineActivation:
[legend]

Public Member Functions

 PiecewiseCosineActivation (double cardiac_period)
 Construct with default parameter values (loader fills via set_param).
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

Piecewise cosine activation function.

This implements the activation function from the LinearElastanceChamber (Regazzoni chamber model). The activation consists of separate contraction and relaxation phases, each following a cosine curve.

\‍[\phi(t, t_C, t_R, T_C, T_R) = \begin{cases}
\frac{1}{2}\left[1 - \cos\left(\frac{\pi}{T_C} \bmod(t - t_C,
T_{HB})\right)\right],
  & \text{if } 0 \le \bmod(t - t_C, T_{HB}) < T_C \\
\frac{1}{2}\left[1 + \cos\left(\frac{\pi}{T_R} \bmod(t - t_R,
T_{HB})\right)\right],
  & \text{if } 0 \le \bmod(t - t_R, T_{HB}) < T_R \\
0, & \text{otherwise}
\end{cases}
\‍]

Constructor & Destructor Documentation

◆ PiecewiseCosineActivation()

PiecewiseCosineActivation::PiecewiseCosineActivation ( double cardiac_period)
inlineexplicit

Construct with default parameter values (loader fills via set_param).

Parameters
cardiac_periodCardiac cycle period

Member Function Documentation

◆ compute()

double PiecewiseCosineActivation::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: