SensorGraphics3DPulse#

class ansys.stk.core.stkobjects.SensorGraphics3DPulse#

Class defining 3D pulse properties of a Sensor.

Overview#

reset_to_defaults

Restore all default values for modulating a sensor’s projection.

show_pulses

Enable display of pulses in the sensor’s projection. If not enabled, the sensor projection is displayed as a transparent, homogeneous color.

amplitude

Amplitude, the transparent/opaque ratio of the pulses. Dimensionless.

length

Pulse length, how much physical space a given pulse occupies. Uses Distance Dimension.

style

Select an available sine or box style from the SensorGraphics3DPulseStyle enumeration. Box styles display a very sharp transition from enabled to disabled for the sensor’s modulation, while the Sine styles display a smooth transition.

enable_smooth

Opt whether to enable averaging of pixels over the range of the pulse to achieve smoother, better viewing quality.

pulse_frequency_preset

Select a frequency option from the SensorGraphics3DPulseFrequencyPreset enumeration. Here, frequency refers to the rate at which pulses occur.

frequency_value

If ePulseFrequencyCustom is selected for the PreselFreq property, specify the custom frequency value. Uses Frequency Dimension.

show_sensor_pulse_in_opposite_direction

Opt whether to have the sensor pulse in a direction opposite from that which is set. This is useful if you want pulsing to display in the same direction as usual but pulsing is faster than the animation step.

Import detail#

from ansys.stk.core.stkobjects import SensorGraphics3DPulse

Property detail#

property SensorGraphics3DPulse.show_pulses: bool#

Enable display of pulses in the sensor’s projection. If not enabled, the sensor projection is displayed as a transparent, homogeneous color.

property SensorGraphics3DPulse.amplitude: float#

Amplitude, the transparent/opaque ratio of the pulses. Dimensionless.

property SensorGraphics3DPulse.length: float#

Pulse length, how much physical space a given pulse occupies. Uses Distance Dimension.

property SensorGraphics3DPulse.style: SensorGraphics3DPulseStyle#

Select an available sine or box style from the SensorGraphics3DPulseStyle enumeration. Box styles display a very sharp transition from enabled to disabled for the sensor’s modulation, while the Sine styles display a smooth transition.

property SensorGraphics3DPulse.enable_smooth: bool#

Opt whether to enable averaging of pixels over the range of the pulse to achieve smoother, better viewing quality.

property SensorGraphics3DPulse.pulse_frequency_preset: SensorGraphics3DPulseFrequencyPreset#

Select a frequency option from the SensorGraphics3DPulseFrequencyPreset enumeration. Here, frequency refers to the rate at which pulses occur.

property SensorGraphics3DPulse.frequency_value: float#

If ePulseFrequencyCustom is selected for the PreselFreq property, specify the custom frequency value. Uses Frequency Dimension.

property SensorGraphics3DPulse.show_sensor_pulse_in_opposite_direction: bool#

Opt whether to have the sensor pulse in a direction opposite from that which is set. This is useful if you want pulsing to display in the same direction as usual but pulsing is faster than the animation step.

Method detail#

SensorGraphics3DPulse.reset_to_defaults(self) None#

Restore all default values for modulating a sensor’s projection.

Returns:

None