SpaceEnvironmentMagnitudeFieldGraphics2D

class ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D

Geomagnetic field graphics settings.

Overview

Methods

compute_b_over_beq	Compute B/Beq (i.e., the ratio of the magnetic field at the specified Earth location to the minimum field intensity along the field line thru the location). Uses Date, Angle, Longitude, and Distance Dimensions.
compute_b_field_as_array	Compute geomagnetic field in Earth Fixed components, returned as the array (Bx, By, Bz), at the specified Earth location. Uses Date, Angle, Longitude, Distance, and MagneticField Dimensions.
compute_dipole__shell	Compute dipole L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.
compute_mcilwain_l_shell	Compute McIlwain L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.

Properties

color_mode	Mode by which color is assigned.
color_ramp_start	Do not use this property, as it is deprecated. Magnetic field start color.
color_ramp_start_color	Magnetic field start color.
color_ramp_stop	Do not use this property, as it is deprecated. Magnetic field stop color.
color_ramp_stop_color	Magnetic field stop color.
color_scale	Scaling of magnetic field to use when assigning color/translucency.
external_field	External magnetic field.
field_line_refresh	Time between refresh of magnetic field lines. Uses Time Dimension.
igrf_update_rate	Duration between updates of IGRF magnetic field model coefficients. Uses Time Dimension.
line_style	Magnetic field line style.
line_width	Magnetic field line width.
main_field	Get or set the main magnetic field.
maximum_translucency	Maximum translucency expressed as a percentage.
number_of_field_lines	Get or set the number of field lines to show per longitude.
number_of_longitudes	Get or set the number of longitudes to show.
reference_longitude	Set initial longitude sample. Longitude is measured about the Z-axis of the Solar Magnetic axes from the -X-axis. Uses Longtitude Dimension.
show_magnetic_field	Flag to show magnetic field.
start_latitude	Get or set the starting magnetic latitude field line to show. Uses Latitude Dimension.
stop_latitude	Get or set the ending magnetic latitude field line to show. Uses Latitude Dimension.

Import detail

from ansys.stk.core.stkobjects import SpaceEnvironmentMagnitudeFieldGraphics2D

Property detail

property SpaceEnvironmentMagnitudeFieldGraphics2D.color_mode: SpaceEnvironmentMagneticFieldColorMode

Mode by which color is assigned.

property SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_start: Color

Do not use this property, as it is deprecated. Magnetic field start color.

property SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_start_color: Color

Magnetic field start color.

property SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_stop: Color

Do not use this property, as it is deprecated. Magnetic field stop color.

property SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_stop_color: Color

Magnetic field stop color.

property SpaceEnvironmentMagnitudeFieldGraphics2D.color_scale: SpaceEnvironmentMagneticFieldColorScaleType

Scaling of magnetic field to use when assigning color/translucency.

property SpaceEnvironmentMagnitudeFieldGraphics2D.external_field: SpaceEnvironmentMagneticExternalField

External magnetic field.

property SpaceEnvironmentMagnitudeFieldGraphics2D.field_line_refresh: float

Time between refresh of magnetic field lines. Uses Time Dimension.

property SpaceEnvironmentMagnitudeFieldGraphics2D.igrf_update_rate: float

Duration between updates of IGRF magnetic field model coefficients. Uses Time Dimension.

property SpaceEnvironmentMagnitudeFieldGraphics2D.line_style: LineStyle

Magnetic field line style.

property SpaceEnvironmentMagnitudeFieldGraphics2D.line_width: LineWidth

Magnetic field line width.

property SpaceEnvironmentMagnitudeFieldGraphics2D.main_field: SpaceEnvironmentMagneticMainField

Get or set the main magnetic field.

property SpaceEnvironmentMagnitudeFieldGraphics2D.maximum_translucency: float

Maximum translucency expressed as a percentage.

property SpaceEnvironmentMagnitudeFieldGraphics2D.number_of_field_lines: int

Get or set the number of field lines to show per longitude.

property SpaceEnvironmentMagnitudeFieldGraphics2D.number_of_longitudes: int

Get or set the number of longitudes to show.

property SpaceEnvironmentMagnitudeFieldGraphics2D.reference_longitude: float

Set initial longitude sample. Longitude is measured about the Z-axis of the Solar Magnetic axes from the -X-axis. Uses Longtitude Dimension.

property SpaceEnvironmentMagnitudeFieldGraphics2D.show_magnetic_field: bool

Flag to show magnetic field.

property SpaceEnvironmentMagnitudeFieldGraphics2D.start_latitude: float

Get or set the starting magnetic latitude field line to show. Uses Latitude Dimension.

property SpaceEnvironmentMagnitudeFieldGraphics2D.stop_latitude: float

Get or set the ending magnetic latitude field line to show. Uses Latitude Dimension.

Method detail

SpaceEnvironmentMagnitudeFieldGraphics2D.compute_b_over_beq(self, time: Any, lat: float, lon: float, alt: float) → float

Compute B/Beq (i.e., the ratio of the magnetic field at the specified Earth location to the minimum field intensity along the field line thru the location). Uses Date, Angle, Longitude, and Distance Dimensions.

Parameters:

time : Any

lat : float

lon : float

alt : float

Returns:

float

SpaceEnvironmentMagnitudeFieldGraphics2D.compute_b_field_as_array(self, time: Any, lat: float, lon: float, alt: float) → list

Compute geomagnetic field in Earth Fixed components, returned as the array (Bx, By, Bz), at the specified Earth location. Uses Date, Angle, Longitude, Distance, and MagneticField Dimensions.

Parameters:

time : Any

lat : float

lon : float

alt : float

Returns:

list

SpaceEnvironmentMagnitudeFieldGraphics2D.compute_dipole__shell(self, time: Any, lat: float, lon: float, alt: float) → float

Compute dipole L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.

Parameters:

time : Any

lat : float

lon : float

alt : float

Returns:

float

SpaceEnvironmentMagnitudeFieldGraphics2D.compute_mcilwain_l_shell(self, time: Any, lat: float, lon: float, alt: float) → float

Compute McIlwain L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.

Parameters:

time : Any

lat : float

lon : float

alt : float

Returns:

float