Struct inertialsim::sensors::SensorModel¶

ClassList > inertialsim > sensors > SensorModel

#include <model.h>

Inherited by the following classes: inertialsim::sensors::InertialSensorModel

Classes¶

Type	Name
struct	Bias Bias simulation options.
struct	DataInterface Data interface simulation options.
struct	InputLimits Input limits simulation options.
struct	Misalignment Misalignment simulation options.
struct	Noise Noise simulation options.
struct	ScaleFactor Scale factor simulation options.

Public Functions¶

Type	Name
	SensorModel () = default
const Bias &	bias () const
Bias &	bias ()
virtual const DataInterface &	data_interface () const
virtual DataInterface &	data_interface ()
const InputLimits &	input_limits () const
InputLimits &	input_limits ()
const Misalignment &	misalignment () const
Misalignment &	misalignment ()
virtual const Noise &	noise () const
virtual Noise &	noise ()
void	reset () Reset model parameters to their defaults.
const ScaleFactor &	scale_factor () const
ScaleFactor &	scale_factor ()
void	set_all (bool value) Set all boolean model parameters.
virtual	~SensorModel () = default

Detailed Description¶

Specify model options for simulating generic sensor errors and data interfaces. These model options are suitable for many types of sensors. By default all supported sources of error are simulated.

Default specifications

Sensor specification parameters default to zero (or identity). Unspecified parameters will have no effect on the simulation result regardless of the settings here.

Public Functions Documentation¶

function SensorModel¶

inertialsim::sensors::SensorModel::SensorModel () = default

function bias [1/2]¶

inline const  Bias & inertialsim::sensors::SensorModel::bias () const

function bias [2/2]¶

inline Bias & inertialsim::sensors::SensorModel::bias ()

function data_interface [1/2]¶

inline virtual const  DataInterface & inertialsim::sensors::SensorModel::data_interface () const

function data_interface [2/2]¶

inline virtual DataInterface & inertialsim::sensors::SensorModel::data_interface ()

function input_limits [1/2]¶

inline const  InputLimits & inertialsim::sensors::SensorModel::input_limits () const

function input_limits [2/2]¶

inline InputLimits & inertialsim::sensors::SensorModel::input_limits ()

function misalignment [1/2]¶

inline const  Misalignment & inertialsim::sensors::SensorModel::misalignment () const

function misalignment [2/2]¶

inline Misalignment & inertialsim::sensors::SensorModel::misalignment ()

function noise [1/2]¶

inline virtual const  Noise & inertialsim::sensors::SensorModel::noise () const

function noise [2/2]¶

inline virtual Noise & inertialsim::sensors::SensorModel::noise ()

function reset¶

Reset model parameters to their defaults.

void inertialsim::sensors::SensorModel::reset ()

function scale_factor [1/2]¶

inline const  ScaleFactor & inertialsim::sensors::SensorModel::scale_factor () const

function scale_factor [2/2]¶

inline ScaleFactor & inertialsim::sensors::SensorModel::scale_factor ()

function set_all¶

Set all boolean model parameters.

void inertialsim::sensors::SensorModel::set_all (
    bool value
)

All boolean model parameters will be set to the input value, true or false. Non-boolean options (like interpolator) will not be modified.

Parameters:

value true or false.

function ~SensorModel¶

virtual inertialsim::sensors::SensorModel::~SensorModel () = default

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