Class inertialsim::sensors::MagnetometerSpecification::Noise¶

ClassList > inertialsim > sensors > MagnetometerSpecification > Noise

Magnetometer noise specification.More...

#include <magnetometer_specification.h>

Inherits the following classes: inertialsim::sensors::SensorSpecification::Noise

Public Functions¶

Type	Name
	Noise (int axes) Construct with default (zero) values.

Public Functions inherited from inertialsim::sensors::SensorSpecification::Noise¶

See inertialsim::sensors::SensorSpecification::Noise

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 inherited from inertialsim::sensors::SensorSpecification::Noise¶

See inertialsim::sensors::SensorSpecification::Noise

Type	Name
int	axes_
Parameter< SpecificationArray >	noise_density_

Protected Functions¶

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

Protected Functions inherited from inertialsim::sensors::SensorSpecification::Noise¶

See inertialsim::sensors::SensorSpecification::Noise

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¶

Random uncorrelated noise in the magnetometer outputs.

Public Functions Documentation¶

function Noise¶

Construct with default (zero) values.

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

Parameters:

axes Number of magnetometer axes (typically 3 for tri-axial).

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::MagnetometerSpecification::Noise::set_noise_density_impl (
    const Parameter < SpecificationArray > & specification
) override

Implements inertialsim::sensors::SensorSpecification::Noise::set_noise_density_impl

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