GaussianSignal Class

Api Class for creating and updating Gaussian Signals

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseGaussianSignal
    ema3d.Api.V25.Core.SignalsAnalyticSignalBaseGaussianSignal, GaussianWaveform
      ema3d.Api.V25.Core.SignalsGaussianSignal

Namespace: ema3d.Api.V25.Core.Signals
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class GaussianSignal : AnalyticSignalBase<GaussianSignal, GaussianWaveform>

Public NotInheritable Class GaussianSignal
	Inherits AnalyticSignalBase(Of GaussianSignal, GaussianWaveform)

public ref class GaussianSignal sealed : public AnalyticSignalBase<GaussianSignal^, GaussianWaveform^>

[<SealedAttribute>]
type GaussianSignal = 
    class
        inherit AnalyticSignalBase<GaussianSignal, GaussianWaveform>
    end

The GaussianSignal type exposes the following members.

Properties

	Name	Description
	Alpha	Alpha
	Amplitude	Amplitude
	AutoConfigure	Auto-Configure will automatically configure the time, amplitude, and alpha parameters for the Gaussian signal to the document's domain settings. Those parameters will be set for the frequency content of the Gaussian to have an amplitude of 1 at the FDTD domain's fundamental frequency and a 60 dB dropoff (amplitude of 0.01) at the FDTD domain's highest resolvable frequency. This parameter is set to "true" by default, and can be used with normalization algorithms to replicate a wide variety of environments in the frequency domain.To manually configure a plane wave, set this parameter to "false" and consult the EMC Plus and Charge Plus user manual for an explanation of the Gaussian Waveform.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Name	Name of the Analytic Signal (Inherited from AnalyticSignalBaseTWrapper, TWave)
	TEnd	The simulation time the signal turns off. The default end time matches the simulation end time (Inherited from AnalyticSignalBaseTWrapper, TWave)
	TPeak	Time to Peak
	TStart	The simulation time the signal turns on. The default start time matches the simulation start time. (Inherited from AnalyticSignalBaseTWrapper, TWave)
	TStep	The sample rate of the signal. The default step time matches the simulation step time. (Inherited from AnalyticSignalBaseTWrapper, TWave)

Top

Methods

	Name	Description
	AttachTo	Attaches the signal to the Wave (Inherited from AnalyticSignalBaseTWrapper, TWave)
	Create	Create a Gaussian Signal
	Delete	Delete the Analytic Signal (Inherited from AnalyticSignalBaseTWrapper, TWave)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all GaussianSignal objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetName	Returns the name of the object. (Inherited from APISimObjectBaseTWrapper)
	GetSiblings	Get all objects that share this object's type in the document. (Overrides APISimObjectBaseTWrapperGetSiblings(Document))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetName	Sets the name of the object (Inherited from APISimObjectBaseTWrapper)
	SetVisibility	Sets the visibility status of the object. (Inherited from APISimObjectBaseTWrapper)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

Python

Copy

from ema3d.Api.V25.Core.Signals import GaussianSignal as GaussianSignal
# Create the signal
_gs = GaussianSignal.Cretae()
_gs.DisplayName = "GaussianSignal"
_gs.AutoConfigure = False
_gs.Amplitude = 60
_gs.Alpha = 6e19

Reference

ema3d.Api.V25.Core.Signals Namespace