FERS 1.0.0
The Flexible Extensible Radar Simulator
Loading...
Searching...
No Matches
radar::RcsChiSquare Class Referencefinal

Chi-square distributed RCS model. More...

#include "target.h"

+ Inheritance diagram for radar::RcsChiSquare:
+ Collaboration diagram for radar::RcsChiSquare:

Public Member Functions

 RcsChiSquare (std::mt19937 &rngEngine, RealType k)
 Constructs an RcsChiSquare model.
 
RealType getK () const noexcept
 Gets the 'k' parameter (degrees of freedom) of the distribution.
 
RealType sampleModel () override
 Samples the chi-square RCS model.
 

Detailed Description

Chi-square distributed RCS model.

Definition at line 80 of file target.h.

Constructor & Destructor Documentation

◆ RcsChiSquare()

radar::RcsChiSquare::RcsChiSquare ( std::mt19937 &  rngEngine,
RealType  k 
)
explicit

Constructs an RcsChiSquare model.

Parameters
rngEngineThe random number engine to use.
kThe degrees of freedom for the chi-square distribution.

Definition at line 89 of file target.h.

89 :
90 _gen(std::make_unique<noise::GammaGenerator>(rngEngine, k)), _k(k)
91 {
92 }

Member Function Documentation

◆ getK()

RealType radar::RcsChiSquare::getK ( ) const
noexcept

Gets the 'k' parameter (degrees of freedom) of the distribution.

Returns
The k value.

Definition at line 98 of file target.h.

98{ return _k; }

◆ sampleModel()

RealType radar::RcsChiSquare::sampleModel ( )
overridevirtual

Samples the chi-square RCS model.

Returns
The sampled RCS value.

Implements radar::RcsModel.

Definition at line 105 of file target.h.

105{ return _gen->getSample(); }

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