Class inertialsim::sensors::SensorSpecification::Noise¶

ClassList > inertialsim > sensors > SensorSpecification > Noise

#include <specification.h>

Inherited by the following classes: inertialsim::sensors::InertialSensorSpecification::Noise, inertialsim::sensors::MagnetometerSpecification::Noise

Public Functions¶

Type	Name
	Noise (int axes) Construct with default (zero) values.
const Parameter< SpecificationArray > &	noise_density () const Get current noise density.
void	set_noise_density (const Parameter< T > & specification) Set noise density.
virtual	~Noise () = default

Protected Attributes¶

Type	Name
int	axes_
Parameter< SpecificationArray >	noise_density_

Protected Functions¶

Type	Name
virtual void	set_noise_density_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of noise density setter. Must validate units and set noise_density_ member.

Detailed Description¶

Common inertial sensor noise terms describing noise density (random walk). See IEEE Std 952-2020 and related standards for details.

Public Functions Documentation¶

function Noise¶

Construct with default (zero) values.

inline explicit inertialsim::sensors::SensorSpecification::Noise::Noise (
    int axes
)

Parameters:

axes Number of sensor axes.

function noise_density¶

Get current noise density.

inline const Parameter < SpecificationArray > & inertialsim::sensors::SensorSpecification::Noise::noise_density () const

Returns:

Parameter with noise density (random walk).

function set_noise_density¶

Set noise density.

template<typename T>
inline void inertialsim::sensors::SensorSpecification::Noise::set_noise_density (
    const Parameter < T > & specification
)

Random white, Gaussian noise in the signal. White, Gaussian noise is uncorrelated in time and normally distributed. The density is the amplitude spectral density in units/sqrt(Hz).

Parameters:

specification Parameter with appropriate units for the sensor type.

Exception:

std::invalid_argument if units are invalid.

function ~Noise¶

virtual inertialsim::sensors::SensorSpecification::Noise::~Noise () = default

Protected Attributes Documentation¶

variable axes_¶

int inertialsim::sensors::SensorSpecification::Noise::axes_;

variable noise_density_¶

Parameter<SpecificationArray> inertialsim::sensors::SensorSpecification::Noise::noise_density_;

Protected Functions Documentation¶

function set_noise_density_impl¶

Implementation of noise density setter. Must validate units and set noise_density_ member.

virtual void inertialsim::sensors::SensorSpecification::Noise::set_noise_density_impl (
    const Parameter < SpecificationArray > & specification
) = 0

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