Table of Contents

Class Magnetometer

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

Class for the Three Axis Magnetometer (TAM) sensor that is able to detect the magnetic field of the craft

public class Magnetometer : Sensor
Inheritance
Magnetometer
Inherited Members

Constructors

Magnetometer()

Default constructor that sets up the sensor

public Magnetometer()

Fields

DCM_SB

[-] DCM from body frame B to sensor frame S

public Matrix3 DCM_SB

Field Value

Matrix3

In_MagneticFieldMsg

[-] Input message for the magnetic field data in the inertial frame N

public MagneticFieldMessage In_MagneticFieldMsg

Field Value

MagneticFieldMessage

MaxOutput

[T] maximum output (ceiling) for saturation application

[EditableVariable("T", 0, false, "", "")]
public double MaxOutput

Field Value

double

MinOutput

[T] minimum output (floor) for saturation application

[EditableVariable("T", 0, false, "", "")]
public double MinOutput

Field Value

double

MinSense

[T] minimum sense (floor) for saturation application

[EditableVariable("T", false, "", "")]
public double MinSense

Field Value

double

Out_TAMSensorMsg

[-] Output message for TAM data in sensor frame S

public TAMSensorMessage Out_TAMSensorMsg

Field Value

TAMSensorMessage

ScaleFactor

[-] Scale factor applied to sensor

[EditableVariable("-", false, "", "")]
public double ScaleFactor

Field Value

double

SensorBias

[T] Sensor bias value

[EditableVariable("T", false, "", "")]
public Vector3 SensorBias

Field Value

Vector3

SensorNoiseStd

[T] Sensor noise value

[EditableVariable("T", false, "", "")]
public Vector3 SensorNoiseStd

Field Value

Vector3

WalkBounds

[T] "3-sigma" errors to permit for Gauss Markov walk bounds

[EditableVariable("T", false, "", "")]
public Vector3 WalkBounds

Field Value

Vector3

Properties

SensedNanoTeslas

[nT] The sensed nano value from the magnetometer in the sensor frame.

[EditableVariable("nT", true, "", "")]
public Vector3 SensedNanoTeslas { get; }

Property Value

Vector3

SensedValue

[T] The sensed value from the magnetometer in the sensor frame.

[EditableVariable("T", true, "", "")]
public Vector3 SensedValue { get; }

Property Value

Vector3

Methods

OnBegin(double)

Called when the 'Component' is beginning

protected override void OnBegin(double time)

Parameters

time double

current time (seconds)

OnEncodeMetadata(JObject)

Called while the "Component" is being saved to save additional metadata.

protected override JObject OnEncodeMetadata(JObject metadata)

Parameters

metadata JObject

Returns

JObject

OnReset(double)

Called when the 'Component' is reset from a simulation

protected override void OnReset(double time)

Parameters

time double

reset time (seconds)

OnUpdate(double, double)

Called when the 'Component' should update

protected override void OnUpdate(double time, double step)

Parameters

time double

current time (seconds)

step double

the time step (seconds)