Description | Example | Return Message | Group

SetConstraint (Sensor)

Set a constraint for a sensor

Syntax

SetConstraint <SensorObjectPath> {ConstraintName} <Parameters>

Related Commands

Description

Warning: Caution should be exercised when turning a constraint Off, in that any previously set constraint values may be lost. These cannot be recovered when the constraint is subsequently turned On.

The SetConstraint command turns constraints for sensors On and Off, and also sets values for the constraints. The following Tables list valid values for {ConstraintName} as well as the values accepted for each. Only one constraint can be set with each SetConstraint command. All angle, latitude and longitude input values are entered in degrees.

Basic Constraints

Basic constraints for sensors vary according to the valid constraints for the parent object. Parent objects can be facilities, places, targets or vehicles. Visit Connect help for the SetConstraint (Facility, Place & Target), or the SetConstraint (Vehicles) commands for a complete list of valid basic constraints.

In addition to the constraints available for parent objects, the chart below summarizes sensor specific basic constraints.

{ConstraintName} <Parameters>
FieldOfView {On | Off}
SensorAzElMask {On | Off}

Sun Constraints

Sun constraints for sensors vary according to the valid constraints for the parent object. Parent objects can be facilities, places, targets or vehicles. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid sun constraints. In addition to the constraints available for parent objects, the chart below summarizes sensor specific sun constraints.

{ConstraintName} <Parameters>
BSSunExclusion {Off | <Value1>}
SunSpecularExclusion {Off | <Value1>}
BSLunarExclusion {Off | <Value1>}

Temporal Constraints

Temporal constraints for sensors vary according to the valid constraints for the parent object. Parent objects can be facilities, places, targets or vehicles. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid temporal constraints.

Advanced Constraints

Advanced constraints for sensors vary according to the valid constraints for the parent object. Vehicles are the only parent objects that have advanced constraints available to them. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid advanced constraints.

Zones Constraints

zones constraints for sensors vary according to the valid constraints for the parent object. Vehicles are the only parent objects that have zones constraints available to them. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of available zones constraints.

Targeting Constraints

Targeting constraints for sensors vary according to the valid constraints for the parent object. Vehicles are the only parent objects that have targeting constraints available to them. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid targeting constraints.

Vector Constraints

Vector constraints for radars vary according to the valid constraints for the parent object. Parent objects can be facilities, places, targets or vehicles. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid vector constraints.

Special Constraints

Special constraints for sensors vary according to the valid constraints for the parent object. Parent objects can be facilities, places, targets or vehicles. Visit Connect help for the SetConstraint (Facility, Place & Target) and the SetConstraint (Vehicles) commands for a complete list of valid special constraints.

Resolution Constraints

{ConstraintName} <Parameters>
GroundSampleDistance {Off | Min <Value1> [|] Max <Value2>}

Warning: The GroundSampleDistance constraint only applies to accesses where a facility, place or target is the other object.

Plugin Constraints

Plugin constraints for radars are identical to that of vehicles. Visit Connect help for the SetConstraint (Vehicles) command for help setting plugin constraints.

Example

To set the maximum crosstrack range for the Horizon sensor on the Shuttle to 200000 m:

SetConstraint */Satellite/Shuttle CrossTrackRange Max 200000

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Sensors

Version

10

STK Programming Interface 11.0.1