Sensor Object

Description

The Sensor object can model unobstructed conical FOV sensors, rectangular (such as slit) sensors, irregularly shaped FOV sensors, and sensor obscurations. See the Sensors Guide for more information.

Inheritance Hierarchy: Object->Hardware->Sensor

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
Active	Determines whether the Sensor is on or off.	Type: Variable Access: Read/Write
ApplyTrackingDataConstraintChecks	Specifies whether to apply range validation to measurements associated with the Sensor. This property is only used in conjunction processing Orbit Determination tracking data.	Type: Variable Access: Read/Write
AttitudeMatrix	The Direction-Cosine-Matrix (DCM) converting between the Sensor's attitude Reference Frame and the Vehicle's Body Coordinate System. The AttitudeMatrix converts from the body coordinate system to the attitude reference frame from left to right. The default Sensor boresight orientation is aligned with the parent Vehicle's body z-axis.	Type: Matrix Access: Read/Write
BoresightAngles	The Euler angles that define the orientation of the Sensor with respect to the Vehicle BCS. The default Sensor boresight orientation is aligned with the parent Vehicle's body z-axis.	Type: Array Access: Read/Write Units: deg
BoresightAttitudeSystem	Determines which attitude system set defines the Sensor orientation state. The chosen element set will determine the attitude properties that are written to an external file when using the Put Command.	Type: String Access: Read/Write
BoresightAzimuth	The boresight azimuth value for each of the 'n' points. Azimuth is defined as the angle from the sensors coordinate frame x-axis measured clockwise toward the y-axis. The default Sensor boresight orientation is aligned with the parent Vehicle's body z-axis.	Type: Array Access: Read/Write Units: deg
BoresightElevation	The boresight elevation value for each of the 'n' points. Elevation in this instance is defined as the angle from the sensor's xy-plane toward the z-axis. The default Sensor boresight orientation is aligned with the parent Vehicle's body z-axis.	Type: Array Access: Read/Write Units: deg
BoresightMaskPoints	The number of points that define the boresight mask.	Type: Variable Access: Read/Write
BoresightRotationSeq	The Euler sequence to use when applying the Euler angles that define the orientation of the Sensor with respect to the Vehicle BCS.	Type: Array Access: Read/Write
BoresightUnitVector	The unit vector in the Vehicle body coordinate system that defines the orientation of the sensor boresight. This vector is defined using the phase and azimuth angles. The default Sensor boresight orientation is aligned with the parent Vehicle's body z-axis.	Type: Array Access: Read/Write
Color	Determines the color of the Sensor, footprint, and sensor swaths in a Mission View. The color can be overridden for an individual view using the ViewWindow.SetObjectColor() method.	Type: Variable Access: Read/Write
ConeHalfAngle	The angle from the sensor boresight to the edge of the sensor field of view.	Type: Variable Access: Read/Write Units: deg
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
FillFootprint	Determines whether the footprint of the sensor over the CentralBody of the Vehicle is filled in on the 2D view mode of the Mission View.	Type: Variable Access: Read/Write
ID	The ID used to associate Vehicle-to-Vehicle tracking measurements with this Sensor.	Type: String Access: Read/Write
InnerConeHalfAngle	The angle from the sensor boresight to the edge of an inner sensor field of view. For an object to be visible to the sensor, the angle between the sensor boresight and the object must be greater than InnerConeHalfAngle but less than Cone HalfAngle.	Type: Variable Access: Read/Write Units: deg
InterpolationMode	The Method used to interpolate between defined points of the sensor mask.	Type: Variable Access: Read/Write
InvertFootprint	Determines whether the footprint of the sensor over the CentralBody of the Vehicle is drawn inverted on the 2d view mode of the Mission View.	Type: Variable Access: Read/Write
MaskType	The mask shape for the sensor boresight.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
ObscurationAttitudeMatrix	The Direction-Cosine-Matrix (DCM) converting between the Sensor's Obscuration's attitude Reference Frame and the Vehicle's Body Coordinate System. The AttitudeMatrix converts from the body coordinate system to the attitude reference frame from left to right.	Type: Matrix Access: Read/Write
ObscurationAttitudeSystem	Determines which attitude system set defines the obscuration orientation state. The chosen element set will determine the attitude properties that are written to an external file when using the Put Command.	Type: String Access: Read/Write
ObscurationAzimuth	The obscuration mask azimuth value for each of the 'n' points. Azimuth is defined as the angle from the obscuration's coordinate frame x-axis measured clockwise toward the y-axis.	Type: Array Access: Read/Write Units: deg
ObscurationConeHalfAngle	The angle from the obscuration mask z-axis to the edge of the constant mask profile.	Type: Variable Access: Read/Write Units: deg
ObscurationElevation	The obscuration mask elevation value for each of the 'n' points. Elevation is defined as the angle from the obscuration's xy-plane toward the z-axis.	Type: Array Access: Read/Write Units: deg
ObscurationEulerAngles	The Euler Angle set that defines the orientation of the sensor obscuration frame with respect to the Vehicle body frame.	Type: Array Access: Read/Write Units: deg
ObscurationInterpolationMode	The method used to interpolate between defined points of the sensor mask.	Type: Variable Access: Read/Write
ObscurationMaskPoints	The number of points that define the obscuration mask.	Type: Variable Access: Read/Write
ObscurationMaskType	The mask shape for the sensor obscuration obscuration.	Type: Variable Access: Read/Write
ObscurationRectangularHalfAngles	The half angle projection in Sensor x and y frames.	Type: Array Access: Read/Write Units: deg
ObscurationRotationSeq	The Euler sequence to use for defining Euler angles that define the orientation of the Obscuration mask referenced to the Vehicle BCS.	Type: Array Access: Read/Write
ObscurationUnitVector	The Unit Vector that defines the z-axis of the obscuration frame referenced from the Vehicle BCS.	Type: Array Access: Read/Write
ObscurationZAxisAzimuth	Azimuth of the z-axis of the Obscuration Mask referenced from the Vehicle BCS.	Type: Variable Access: Read/Write Units: deg
ObscurationZAxisElevation	Elevation of the z-axis of the Obscuration Mask referenced from the Vehicle BCS.	Type: Variable Access: Read/Write Units: deg
OD	This property contains the OD settings for all the Sensor properties that can be estimated.	Type: SensorODProperties Access: Read-Only
Opacity	The opacity of the Sensor when visualized in a Mission View. This does not apply to the Sensor outline. The opacity can be overridden for an individual view using ViewWindow.SetObjectOpacity() method.	Type: Variable Access: Read/Write
PixelDensity	Determines the number of Sensor pixels centered on the boresight (z-axis) along the x- and y-axis of the sensor. This is used by the Sensor view mode of a Mission View.	Type: Array Access: Read/Write
PixelThreshold	Determines the threshold value of a Sensor pixel. The threshold determines how much luminosity is required to excite a pixel. This is used by the Sensor view mode of a Mission View.	Type: Variable Access: Read/Write
Position	The position offset of the sensor in the body coordinate system of the parent Vehicle. This offset is applied for visualization purposes, antenna modeling purposes for orbit determination and RFLink analyses, and when calculating vectors using methods such as Vector.BuildVector, Sensor.FixedVectorToObject, and Sensor.VectorToObject. For other applications, this does not change the actual position of the sensor.	Type: Array Access: Read/Write Units: km
ProjectionHeight	The maximum height of the projected sensor mask as measured from the location of the sensor when viewed in the 3-D view mode of the Mission View. If the projection intersects a celestial body before reaching its maximum height, it will be limited to the height at intersection. The projection height can be overridden for an individual view using ViewWindow.SetObjectProjectionHeight() method.	Type: Variable Access: Read/Write Units: km
RangeRateAveragingInterval	The time interval over which the Vehicle Observation Range-Rate measurements are averaged. When using instantaneous data, this interval should be set to 1 millisecond.	Type: Variable Access: Read/Write Units: s
ReceiveFrequency	The antenna downlink frequency. Note: This property is needed only if the Sensor object is used for Orbit Determination processing of Vehicle Observation data.	Type: Variable Access: Read/Write Units: Hz
RectangularHalfAngles	The half angle projection in Sensor x and y frames.	Type: Array Access: Read/Write Units: deg
TransmitFrequency	The antenna uplink frequency. Note: This property is needed only if the Sensor object is used for Orbit Determination processing of Vehicle Observation data.	Type: Variable Access: Read/Write Units: Hz
UseObscurationMasking	Flag identifying whether the obscuration mask should be used: a value of 0 means that the obscuration is not used, and a value of 1 means that the obscuration is used.	Type: Variable Access: Read/Write
ZAxisAzimuth	Azimuth of the z-axis of the Sensor referenced from the Vehicle BCS. Azimuth in this instance is defined as the angle from the Vehicle xy-polar plane to the sensors xy-polar plane measured clockwise toward the y-axis.	Type: Variable Access: Read/Write Units: deg
ZAxisElevation	Elevation of the z-axis of the Sensor referenced from the Vehicle BCS. Elevation in this instance is defined as the angle from the Vehicle z-axis to the Sensor z-axis.	Type: Variable Access: Read/Write Units: deg

Name

Description

Attributes

BoresightAngle1

The first of the three Euler angles that define the orientation of the sensor boresight frame with respect to the Vehicle body frame.

Use the Sensor.BoresightRotationSeq property to control which axis each Euler rotation is about. By default, the rotation sequence is {3, 1, 2}, so the first boresight angle measures a rotation about the third axis and so forth.

This property has been Deprecated. Please use BoresightAngles instead.