Class inertialsim::sensors::WhiteNoiseBuffer

ClassList > inertialsim > sensors > WhiteNoiseBuffer

A buffer for white noise samples. More...

• #include <noise.h>

Public Functions

Type	Name
bool	HasSamples () const Check if buffer has any samples.
Array	History () const Return all samples previously generated.
void	Reset () Reset buffer.
Array	Sample (Eigen::Index num_samples, const SpecificationArray & standard_deviation) Sample the buffer.
Array	Sample (Eigen::Index num_samples, const double standard_deviation) Sample the buffer.
	WhiteNoiseBuffer (Eigen::Index channels, uint64_t seed=0) Construct a new WhiteNoiseBuffer .

Detailed Description

Sample and store a multi-channel white noise process. The primary purpose of this class is to store a history of all previous noise samples.

Public Functions Documentation

function HasSamples

Check if buffer has any samples.

inline bool inertialsim::sensors::WhiteNoiseBuffer::HasSamples () const

Returns:

True if buffer has samples.

---

function History

Return all samples previously generated.

Array inertialsim::sensors::WhiteNoiseBuffer::History () const

Returns:

Random samples, or empty matrix if none.

---

function Reset

Reset buffer.

void inertialsim::sensors::WhiteNoiseBuffer::Reset () 

---

function Sample [½]

Sample the buffer.

Array inertialsim::sensors::WhiteNoiseBuffer::Sample (
    Eigen::Index num_samples,
    const SpecificationArray & standard_deviation
) 

Parameters:

• num_samples Number of samples to return.
• standard_deviation Standard deviation of the samples.

Returns:

Random samples.

---

function Sample [2/2]

Sample the buffer.

Array inertialsim::sensors::WhiteNoiseBuffer::Sample (
    Eigen::Index num_samples,
    const double standard_deviation
) 

Parameters:

• num_samples Number of samples to return.
• standard_deviation Standard deviation of the samples.

Returns:

Random samples.

---

function WhiteNoiseBuffer

Construct a new WhiteNoiseBuffer .

explicit inertialsim::sensors::WhiteNoiseBuffer::WhiteNoiseBuffer (
    Eigen::Index channels,
    uint64_t seed=0
) 

Parameters:

• channels Number of channels.
• seed Random seed (optional).

---

---

The documentation for this class was generated from the following file cpp/include/inertialsim/sensors/noise.h