Class inertialsim::sensors::SensorSpecification::ScaleFactor¶

ClassList > inertialsim > sensors > SensorSpecification > ScaleFactor

Scale factor specification. More...

#include <specification.h>

Public Functions¶

Type	Name
	ScaleFactor (int axes) Construct with default values.
const Parameter< SpecificationArray > &	fixed () const Get fixed scale factor.
const Parameter< SpecificationArray > &	repeatability () const Get scale factor repeatability.
void	set_fixed (const Parameter< double > & specification) Set fixed scale factor error.
void	set_fixed (const Parameter< SpecificationArray > & specification)
void	set_repeatability (const Parameter< double > & specification) Set scale factor repeatability.
void	set_repeatability (const Parameter< SpecificationArray > & specification)

Detailed Description¶

Scale factor is the ratio of change in output to change in input at the analog sensing elements. A perfect sensor has a linear analog response with a scale of 1.0.

Public Functions Documentation¶

function ScaleFactor¶

Construct with default values.

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

function fixed¶

Get fixed scale factor.

inline const Parameter < SpecificationArray > & inertialsim::sensors::SensorSpecification::ScaleFactor::fixed () const

Returns:

Parameter with fixed scale factor error.

function repeatability¶

Get scale factor repeatability.

inline const Parameter < SpecificationArray > & inertialsim::sensors::SensorSpecification::ScaleFactor::repeatability () const

Returns:

Parameter with scale factor repeatability (standard deviation).

function set_fixed [½]¶

Set fixed scale factor error.

void inertialsim::sensors::SensorSpecification::ScaleFactor::set_fixed (
    const Parameter < double > & specification
)

Accepts scalar or vector parameters and converts to a vector of size axes_. Validates that units are dimensionless, %, or ppm.

Parameters:

specification Scalar or vector Parameter with scale factor error.

Exception:

std::invalid_argument if units are invalid.

function set_fixed [2/2]¶

void inertialsim::sensors::SensorSpecification::ScaleFactor::set_fixed (
    const Parameter < SpecificationArray > & specification
)

function set_repeatability [½]¶

Set scale factor repeatability.

void inertialsim::sensors::SensorSpecification::ScaleFactor::set_repeatability (
    const Parameter < double > & specification
)

Accepts scalar or vector parameters and converts to a vector of size axes_. Validates that units are dimensionless, %, or ppm.

Parameters:

specification Scalar or vector Parameter with scale factor repeatability.

Exception:

std::invalid_argument if units are invalid.

function set_repeatability [2/2]¶

void inertialsim::sensors::SensorSpecification::ScaleFactor::set_repeatability (
    const Parameter < SpecificationArray > & specification
)

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