BioDynaMo  v1.03.58-27764645
Public Member Functions | Private Attributes | List of all members
bdm::PoissonBand Class Reference

#include <substance_initializers.h>

Public Member Functions

 PoissonBand (real_t lambda, uint8_t axis)
 The constructor. More...
 
real_t operator() (real_t x, real_t y, real_t z)
 The model that we want to apply for substance initialization. The operator is called for the entire space. More...
 

Private Attributes

real_t lambda_
 
uint8_t axis_
 

Detailed Description

An initializer that follows a Poisson (normal) distribution along one axis The function ROOT::Math::poisson_pdfd(X, lambda) follows the normal probability density function: {e^( - lambda ) * lambda ^x )} / x!

Definition at line 133 of file substance_initializers.h.

Constructor & Destructor Documentation

◆ PoissonBand()

bdm::PoissonBand::PoissonBand ( real_t  lambda,
uint8_t  axis 
)
inline

The constructor.

Parameters
[in]lambdaThe lambda of the Poisson distribution
[in]axisThe axis along which you want the Poisson distribution to be oriented to

Definition at line 141 of file substance_initializers.h.

Member Function Documentation

◆ operator()()

real_t bdm::PoissonBand::operator() ( real_t  x,
real_t  y,
real_t  z 
)
inline

The model that we want to apply for substance initialization. The operator is called for the entire space.

Parameters
[in]xThe x coordinate
[in]yThe y coordinate
[in]zThe z coordinate

Definition at line 153 of file substance_initializers.h.

Member Data Documentation

◆ axis_

uint8_t bdm::PoissonBand::axis_
private

Definition at line 168 of file substance_initializers.h.

◆ lambda_

real_t bdm::PoissonBand::lambda_
private

Definition at line 167 of file substance_initializers.h.


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