insSensor
Description
The insSensor
System object™ models a device that fuses measurements from an inertial navigation system (INS)
and global navigation satellite system (GNSS) such as a GPS, and outputs the fused
measurements.
To output fused INS and GNSS measurements:
Create the
insSensor
object and set its properties.Call the object with arguments, as if it were a function.
To learn more about how System objects work, see What Are System Objects?
Creation
Description
returns a System object, INS
= insSensorINS
, that models a device that outputs measurements from
an INS and GNSS.
sets properties using one or
more name-value pairs. Unspecified properties have default values. Enclose each property
name in quotes.INS
= insSensor(Name,Value
)
Properties
Unless otherwise indicated, properties are nontunable, which means you cannot change their
values after calling the object. Objects lock when you call them, and the
release
function unlocks them.
If a property is tunable, you can change its value at any time.
For more information on changing property values, see System Design in MATLAB Using System Objects.
MountingLocation
— Location of sensor on platform (m)
[0 0 0]
(default) | three-element real-valued vector of form [x
y
z]
Location of the sensor on the platform, in meters, specified as a three-element real-valued vector of the form [x y z]. The vector defines the offset of the sensor origin from the origin of the platform.
Tunable: Yes
Data Types: single
| double
RollAccuracy
— Accuracy of roll measurement (deg)
0.2
(default) | nonnegative real scalar
Accuracy of the roll measurement of the sensor body, in degrees, specified as a nonnegative real scalar.
Roll is the rotation around the x-axis of
the sensor body. Roll noise is modeled as a white noise process.
RollAccuracy
sets the standard deviation of the roll measurement
noise.
Tunable: Yes
Data Types: single
| double
PitchAccuracy
— Accuracy of pitch measurement (deg)
0.2
(default) | nonnegative real scalar
Accuracy of the pitch measurement of the sensor body, in degrees, specified as a nonnegative real scalar.
Pitch is the rotation around the y-axis of
the sensor body. Pitch noise is modeled as a white noise process.
PitchAccuracy
defines the standard deviation of the pitch
measurement noise.
Tunable: Yes
Data Types: single
| double
YawAccuracy
— Accuracy of yaw measurement (deg)
1
(default) | nonnegative real scalar
Accuracy of the yaw measurement of the sensor body, in degrees, specified as a nonnegative real scalar.
Yaw is the rotation around the z-axis of
the sensor body. Yaw noise is modeled as a white noise process.
YawAccuracy
defines the standard deviation of the yaw measurement
noise.
Tunable: Yes
Data Types: single
| double
PositionAccuracy
— Accuracy of position measurement (m)
[1 1 1]
(default) | nonnegative real scalar | three-element real-valued vector
Accuracy of the position measurement of the sensor body, in meters, specified as a
nonnegative real scalar or a three-element real-valued vector. The elements of the
vector set the accuracy of the x-, y-, and
z-position measurements, respectively. If you specify
PositionAccuracy
as a scalar value, then the object sets the
accuracy of all three positions to this value.
Position noise is modeled as a white noise process.
PositionAccuracy
defines the standard deviation of the position
measurement noise.
Tunable: Yes
Data Types: single
| double
VelocityAccuracy
— Accuracy of velocity measurement (m/s)
0.05
(default) | nonnegative real scalar
Accuracy of the velocity measurement of the sensor body, in meters per second, specified as a nonnegative real scalar.
Velocity noise is modeled as a white noise process.
VelocityAccuracy
defines the standard deviation of the velocity
measurement noise.
Tunable: Yes
Data Types: single
| double
AccelerationAccuracy
— Accuracy of acceleration measurement (m/s2)
0
(default) | nonnegative real scalar
Accuracy of the acceleration measurement of the sensor body, in meters per second, specified as a nonnegative real scalar.
Acceleration noise is modeled as a white noise process.
AccelerationAccuracy
defines the standard deviation of the
acceleration measurement noise.
Tunable: Yes
Data Types: single
| double
AngularVelocityAccuracy
— Accuracy of angular velocity measurement (deg/s)
0
(default) | nonnegative real scalar
Accuracy of the angular velocity measurement of the sensor body, in meters per second, specified as a nonnegative real scalar.
Angular velocity is modeled as a white noise process.
AngularVelocityAccuracy
defines the standard deviation of the
acceleration measurement noise.
Tunable: Yes
Data Types: single
| double
TimeInput
— Enable input of simulation time
false
or 0
(default) | true
or 1
Enable input of simulation time, specified as a logical 0
(false
) or 1
(true
). Set this
property to true
to input the simulation time by using the simTime
argument.
Tunable: No
Data Types: logical
HasGNSSFix
— Enable GNSS fix
true
or 1
(default) | false
or 0
Enable GNSS fix, specified as a logical 1
(true
) or 0
(false
). Set this
property to false
to simulate the loss of a GNSS receiver fix. When a
GNSS receiver fix is lost, position measurements drift at a rate specified by the
PositionErrorFactor
property.
Tunable: Yes
Dependencies
To enable this property, set TimeInput
to
true
.
Data Types: logical
PositionErrorFactor
— Position error factor without GNSS fix
[0 0 0]
(default) | nonnegative scalar | 1-by-3 vector of scalars
Position error factor without GNSS fix, specified as a scalar or a 1-by-3 vector of scalars.
When the HasGNSSFix
property is set to
false
, the position error grows at a quadratic rate due to constant
bias in the accelerometer. The position error for a position component
E(t) can be expressed as
E(t) =
1/2αt2, where
α is the position error factor for the corresponding component and
t is the time since the GNSS fix is lost. While running, the object
computes t based on the simTime
input. The
computed E(t) values for the x,
y, and z components are added to the
corresponding position components of the gTruth
input.
Tunable: Yes
Dependencies
To enable this property, set TimeInput
to
true
and HasGNSSFix
to
false
.
Data Types: single
| double
RandomStream
— Random number source
'Global stream'
(default) | 'mt19937ar with seed'
Random number source, specified as one of these options:
'Global stream'
–– Generate random numbers using the current global random number stream.'mt19937ar with seed'
–– Generate random numbers using the mt19937ar algorithm, with the seed specified by theSeed
property.
Data Types: char
| string
Seed
— Initial seed
67
(default) | nonnegative integer
Initial seed of the mt19937ar random number generator algorithm, specified as a nonnegative integer.
Dependencies
To enable this property, set RandomStream
to
'mt19937ar with seed'
.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
Usage
Description
models the data received from an INS sensor reading and GNSS sensor reading. The output
measurement is based on the inertial ground-truth state of the sensor body,
measurement
= INS(gTruth
)gTruth
.
additionally specifies the time of simulation, measurement
= INS(gTruth
,simTime
)simTime
. To enable
this syntax, set the TimeInput
property to true
.
Input Arguments
gTruth
— Inertial ground-truth state of sensor body
structure
Inertial ground-truth state of sensor body, in local Cartesian coordinates, specified as a structure containing these fields:
Field | Description |
---|---|
'Position' | Position, in meters, specified as a real, finite N-by-3 matrix of [x y z] vectors. N is the number of samples in the current frame. |
'Velocity' | Velocity (v), in meters per second, specified as a real, finite N-by-3 matrix of [vx vy vz] vector. N is the number of samples in the current frame. |
'Orientation' | Orientation with respect to the local Cartesian coordinate system, specified as one of these options:
Each quaternion or rotation matrix is a frame rotation from the local Cartesian coordinate system to the current sensor body coordinate system. N is the number of samples in the current frame. |
'Acceleration' | Acceleration (a), in meters per second squared, specified as a real, finite N-by-3 matrix of [ax ay az] vectors. N is the number of samples in the current frame. |
'AngularVelocity' | Angular velocity (ω), in degrees per second squared, specified as a real, finite N-by-3 matrix of [ωx ωy ωz] vectors. N is the number of samples in the current frame. |
The field values must be of type double
or
single
.
The Position
, Velocity
, and
Orientation
fields are required. The other fields are
optional.
Example: struct('Position',[0 0 0],'Velocity',[0 0
0],'Orientation',quaternion([1 0 0 0]))
simTime
— Simulation time
nonnegative real scalar
Simulation time, in seconds, specified as a nonnegative real scalar.
Data Types: single
| double
Output Arguments
measurement
— Measurement of sensor body motion
structure
Measurement of the sensor body motion, in local Cartesian coordinates, returned as a structure containing these fields:
Field | Description |
---|---|
'Position' | Position, in meters, specified as a real, finite N-by-3 matrix of [x y z] vectors. N is the number of samples in the current frame. |
'Velocity' | Velocity (v), in meters per second, specified as a real, finite N-by-3 matrix of [vx vy vz] vector. N is the number of samples in the current frame. |
'Orientation' | Orientation with respect to the local Cartesian coordinate system, specified as one of these options:
Each quaternion or rotation matrix is a frame rotation from the local Cartesian coordinate system to the current sensor body coordinate system. N is the number of samples in the current frame. |
'Acceleration' | Acceleration (a), in meters per second squared, specified as a real, finite N-by-3 matrix of [ax ay az] vectors. N is the number of samples in the current frame. |
'AngularVelocity' | Angular velocity (ω), in degrees per second squared, specified as a real, finite N-by-3 matrix of [ωx ωy ωz] vectors. N is the number of samples in the current frame. |
The returned field values are of type double
or
single
and are of the same type as the corresponding field values
in the gTruth
input.
Object Functions
To use an object function, specify the
System object as the first input argument. For
example, to release system resources of a System object named obj
, use
this syntax:
release(obj)
Specific to insSensor
perturbations | Perturbation defined on object |
perturb | Apply perturbations to object |
Examples
Generate INS Measurements from Stationary Input
Create a motion structure that defines a stationary position at the local north-east-down (NED) origin. Because the platform is stationary, you need to define only a single sample. Assume the ground-truth motion is sampled for 10 seconds with a 100 Hz sample rate. Create a default insSensor
System object™. Preallocate variables to hold output from the insSensor
object.
Fs = 100; duration = 10; numSamples = Fs*duration; motion = struct( ... 'Position',zeros(1,3), ... 'Velocity',zeros(1,3), ... 'Orientation',ones(1,1,'quaternion')); INS = insSensor; positionMeasurements = zeros(numSamples,3); velocityMeasurements = zeros(numSamples,3); orientationMeasurements = zeros(numSamples,1,'quaternion');
In a loop, call INS
with the stationary motion structure to return the position, velocity, and orientation measurements in the local NED coordinate system. Log the position, velocity, and orientation measurements.
for i = 1:numSamples measurements = INS(motion); positionMeasurements(i,:) = measurements.Position; velocityMeasurements(i,:) = measurements.Velocity; orientationMeasurements(i) = measurements.Orientation; end
Convert the orientation from quaternions to Euler angles for visualization purposes. Plot the position, velocity, and orientation measurements over time.
orientationMeasurements = eulerd(orientationMeasurements,'ZYX','frame'); t = (0:(numSamples-1))/Fs; subplot(3,1,1) plot(t,positionMeasurements) title('Position') xlabel('Time (s)') ylabel('Position (m)') legend('North','East','Down') subplot(3,1,2) plot(t,velocityMeasurements) title('Velocity') xlabel('Time (s)') ylabel('Velocity (m/s)') legend('North','East','Down') subplot(3,1,3) plot(t,orientationMeasurements) title('Orientation') xlabel('Time (s)') ylabel('Rotation (degrees)') legend('Roll', 'Pitch', 'Yaw')
Tips
To obtain the ground-truth state of actors in a driving scenario, use the
state
function.The sensor reports measurements in the local Cartesian coordinate system. To convert these measurements to geographic positions for visualization on a map, use the
local2latlon
function. To convert this data back to local coordinates, use thelatlon2local
function.
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.
The object functions, perturbations
and
perturb
, do not support code generation.
Usage notes and limitations:
See System Objects in MATLAB Code Generation (MATLAB Coder).
Version History
Introduced in R2021a
See Also
Objects
Objects
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)