Satellite#

class ansys.stk.core.stkobjects.Satellite#

Bases: ISTKObject, ILifetimeInformation, IProvideSpatialInfo

Satellite properties.

Overview#

Methods

`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.
`set_attitude_type`	Set the attitude type.
`set_propagator_type`	Set the propagator type.

Properties

`access_constraints`	Get the constraints imposed on the satellite.
`attitude`	Get the Attitude properties of the satellite.
`attitude_supported_types`	Return an array of valid choices.
`attitude_type`	Get the type of the satellite’s attitude.
`chain_analysis_options`	Get the satellite’s chain analysis options.
`eclipse_bodies`	Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.
`export_tools`	Return the SatelliteExportTools interface.
`get_eoir_settings`	Get the EOIR properties of the satellite.
`graphics`	Get the 2D Graphics properties of the satellite.
`graphics_3d`	Get the 3D Graphics properties of the satellite.
`ground_ellipses`	Get the Ground Ellipses properties of the satellite.
`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.
`lighting_maximum_step_terrain`	Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
`mass_properties`	Get the Mass properties of the satellite.
`pass_break`	Get the Pass Break properties of the satellite.
`propagator`	Get information for the propagator.
`propagator_supported_types`	Return an array of valid choices.
`propagator_type`	Get the type of propagator used to define the satellite’s orbit.
`radar_cross_section`	Return the radar cross sectoin.
`reference_vehicle`	Get the reference vehicle of the satellite.
`space_environment`	Get the SpaceEnvironment properties of the satellite.
`use_terrain_in_lighting_computations`	Opt whether to compute lighting using terrain data.

Examples#

Set satellite attitude external

# Satellite satellite: Satellite object
if os.name == "nt":
    installPath = r"C:\Program Files\AGI\STK_ODTK 13"
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.access_constraints: AccessConstraintCollection#: Get the constraints imposed on the satellite.

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

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

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

property Satellite.chain_analysis_options: ChainAnalysisOptions#: Get the satellite’s chain analysis options.

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

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

property Satellite.get_eoir_settings: IEOIR#: Get the EOIR 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.ground_ellipses: VehicleGroundEllipsesCollection#: Get the Ground Ellipses properties of the satellite.

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.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.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.propagator: IPropagator#: Get information for the propagator.

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

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

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

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

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

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

Method detail#

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

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

Set the attitude type.

Parameters:: attitude : VehicleAttitude
Returns:: None

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

Set the propagator type.

Parameters:: propagator : PropagatorType
Returns:: None