Satellite#

class ansys.stk.core.stkobjects.Satellite#

Bases: ISTKObject, ILifetimeInformation, IProvideSpatialInfo

Satellite properties.

Overview#

Methods

`set_propagator_type`	Set the propagator type.
`set_attitude_type`	Set the attitude type.
`is_attitude_type_supported`	Get a value indicating whether the specified type can be used.
`is_propagator_type_supported`	Get a value indicating whether the specified type can be used.

Properties

`propagator_type`	Get the type of propagator used to define the satellite’s orbit.
`propagator`	Get information for the propagator.
`attitude_type`	Get the type of the satellite’s attitude.
`attitude_supported_types`	Return an array of valid choices.
`attitude`	Get the Attitude properties of the satellite.
`mass_properties`	Get the Mass properties of the satellite.
`pass_break`	Get the Pass Break properties of the satellite.
`ground_ellipses`	Get the Ground Ellipses properties of the satellite.
`graphics`	Get the 2D Graphics properties of the satellite.
`graphics_3d`	Get the 3D Graphics properties of the satellite.
`access_constraints`	Get the constraints imposed on the satellite.
`eclipse_bodies`	Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.
`propagator_supported_types`	Return an array of valid choices.
`export_tools`	Return the SatelliteExportTools interface.
`space_environment`	Get the SpaceEnvironment properties of the satellite.
`reference_vehicle`	Get the reference vehicle of the satellite.
`radar_clutter_map`	Return the radar clutter map.
`radar_cross_section`	Return the radar cross sectoin.
`use_terrain_in_lighting_computations`	Opt whether to compute lighting using terrain data.
`lighting_maximum_step`	Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
`lighting_maximum_step_terrain`	Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
`lighting_maximum_step_central_body_shape`	Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
`get_eoir_settings`	Get the EOIR properties of the satellite.

Examples#

Set satellite attitude external

# Satellite satellite: Satellite object
if os.name == "nt":
    installPath = r"C:\Program Files\AGI\STK 12"
else:
    installPath = os.environ["STK_INSTALL_DIR"]
satellite.attitude.external.load(
    os.path.join(installPath, "Data", "Resources", "stktraining", "text", "AttitudeTimeEulerAngles_Example.a")
)

Set satellite attitude targeting

# Satellite satellite: Satellite object
attitudePointing = satellite.attitude.pointing
attitudePointing.use_target_pointing = True
attitudePointing.targets.remove_all()
attitudePointing.targets.add("AreaTarget/MyAreaTarget")
attitudePointing.target_times.use_access_times = True

Set satellite attitude basic spinning

# Satellite satellite: Satellite object
basic = satellite.attitude.basic
basic.set_profile_type(AttitudeProfile.SPINNING)
basic.profile.body.assign_xyz(0, 0, 1)
basic.profile.inertial.assign_xyz(0, 1, 0)
basic.profile.rate = 6  # rev/sec

Create a satellite (on the current scenario central body)

# STKObjectRoot root: STK Object Model Root
satellite = root.current_scenario.children.new(STKObjectType.SATELLITE, "MySatellite")

Import detail#

from ansys.stk.core.stkobjects import Satellite

Property detail#

property Satellite.propagator_type: PropagatorType#: Get the type of propagator used to define the satellite’s orbit.

property Satellite.propagator: IPropagator#: Get information for the propagator.

property Satellite.attitude_type: VehicleAttitude#: Get the type of the satellite’s attitude.

property Satellite.attitude_supported_types: list#: Return an array of valid choices.

property Satellite.attitude: IVehicleAttitude#: Get the Attitude properties of the satellite.

property Satellite.mass_properties: VehicleMassProperties#: Get the Mass properties of the satellite.

property Satellite.pass_break: PassBreak#: Get the Pass Break properties of the satellite.

property Satellite.ground_ellipses: VehicleGroundEllipsesCollection#: Get the Ground Ellipses properties of the satellite.

property Satellite.graphics: SatelliteGraphics#: Get the 2D Graphics properties of the satellite.

property Satellite.graphics_3d: SatelliteGraphics3D#: Get the 3D Graphics properties of the satellite.

property Satellite.access_constraints: AccessConstraintCollection#: Get the constraints imposed on the satellite.

property Satellite.eclipse_bodies: VehicleEclipseBodies#: Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.

property Satellite.propagator_supported_types: list#: Return an array of valid choices.

property Satellite.export_tools: SatelliteExportTools#: Return the SatelliteExportTools interface.

property Satellite.space_environment: SpaceEnvironment#: Get the SpaceEnvironment properties of the satellite.

property Satellite.reference_vehicle: LinkToObject#: Get the reference vehicle of the satellite.

property Satellite.radar_clutter_map: IRadarClutterMapInheritable#: Return the radar clutter map.

property Satellite.radar_cross_section: RadarCrossSectionInheritable#: Return the radar cross sectoin.

property Satellite.use_terrain_in_lighting_computations: bool#: Opt whether to compute lighting using terrain data.

property Satellite.lighting_maximum_step: float#: Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.

property Satellite.lighting_maximum_step_terrain: float#: Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.

property Satellite.lighting_maximum_step_central_body_shape: float#: Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.

property Satellite.get_eoir_settings: IEOIR#: Get the EOIR properties of the satellite.

Method detail#

Satellite.set_propagator_type(self, propagator: PropagatorType) → None#

Set the propagator type.

Parameters:: propagator : PropagatorType
Returns:: None

Satellite.set_attitude_type(self, attitude: VehicleAttitude) → None#

Set the attitude type.

Parameters:: attitude : VehicleAttitude
Returns:: None

Satellite.is_attitude_type_supported(self, attitude: VehicleAttitude) → bool#

Get a value indicating whether the specified type can be used.

Parameters:: attitude : VehicleAttitude
Returns:: bool

Satellite.is_propagator_type_supported(self, propagator: PropagatorType) → bool#

Get a value indicating whether the specified type can be used.

Parameters:: propagator : PropagatorType
Returns:: bool