ScalarPlot2D Object

This object allows to plot three dimensional vector fields on a cutting plane. Therefore the 3D Fields on 2D Plane option has to be active. To choose what field to plot, the SelectTreeItem command can be used.

• General Methods

• Query

• Default Settings

• Example

General Methods:

Type ( enum key )

Selects the type of Plot.

key can have one of  the following values:

PlotAmplitude ( bool switch )

If switch is True, the absolute values (the amplitudes) of the complex scalar values are plotted.

PhaseValue ( double phase )

Specifies the phase of to be plotted complex field values.

PhaseStep ( double step )

Specifies the step width used by phase incrementing actions.

Scaling ( int scale )

Defines a scale factor of the plotted objects. A value between 0 and 100 may be given. This value influences the size of the objects.

dBScale ( bool switch )

Decides whether the fields should be plotted in a dB scale  or not.

dBUnit ( int  unit )

Sets the a unit for logarithmic farfield plots. The unit must be integer  and between "0" and "4". ("0" = "3D Max  = 0 dB", "1" =   "2D Max  = 0 dB",

"2" = "dBV/m", "3" = "dBmV/m", "4" = "dBuV/m").

dBRange ( double range )

Sets the logarithmic field plot range in dB.

Please note: range must be a double value here. Any expression is not allowed.

LogScale ( bool switch )

Decides whether the fields should be plotted in a logarithmical scale or not.

LogStrength ( double strength )

The characteristic curve used for logarithmic scaling can be varied. Values from 1.0e-6 to 100000 are allowed.

ScaleToVectorMaximum ( bool switch )

All components will be scaled to the vector maximum. Thus different components can be compared. If not enabled, the components are scaled to their own maximum.

ScaleToRange ( bool switch )

Scales the plot to a range given by ScaleRange. (The used color ramp represents the values between the given interval) This is useful to compare plots with different maximum values.

ScaleRange ( double min, double max )

Sets the minimal and maximal values of the plot. This setting has only an effect, if ScaleToRange is True.

Quality ( int quality )

The Plot data for scalar values on surfaces is represented by triangles. This setting influences the number of triangles used for the plot. A fine plot quality will result in a longer plot generation time and thus in slower movies as well. A value between 0 and 100 may be given.

Transparency ( double transparency )

Sets the transparency for drawing contour plots or carpet plots. The transparency value is a floating point number in the range from 0.0 to 1.0. A value of 0.0 means that the field visualization is drawn opaquely whereas a value of 1.0 indicates that the field data is drawn completely transparent (invisible).

PlaneNormal ( enum normal )

Sets the direction of the cutting plane where the fields are to be plotted. The position of the plane can be set by PlaneCoordinate.

normal can have one of  the following values:

PlaneCoordinate ( double position )

Sets the position of the cutting plane where the fields are to be plotted. The direction of the plane can be set by PlaneNormal.

SetTime ( double time )

The current time value of a time monitor plot is set.

SetSample ( long sample )

The current time sample number of a time monitor plot is set.

Plot

Plots the field with the previously made settings.

Query:

GetDomain enum

Returns the domain of the monitor used, return code can have the following values:

GetNumberOfSamples long

Returns the total number of samples if the plot is based on recordings of a time monitor else 0.

GetTStart double

Returns the start time of recording if the plot is based on recordings of a time monitor else 0.0.

GetTEnd double

Returns the end time of recording if the plot is based on recordings of a time monitor else 0.0.

GetTStep double

Returns the time step width of recording if the plot is based on recordings of a time monitor else 0.0.

GetTime double

Returns the current  time set of a time monitor plot.

GetSample long

Returns the current time sample number of a time monitor plot.

Default Settings:

Type ("contour")

PlotAmplitude (False)

PhaseValue (0.0)

PhaseStep (22.5)

Scaling (50)

LogScale (False)

LogStrength (10.0)

ScaleToVectorMaximum (True)

ScaleToRange (False)

ScaleRange (0.0, 0.0)

Quality (50)

PlaneNormal ("x")

PlaneCoordinate (0.0)

SetTime (0.0)

SetSample (0)

Example:

The following script plots surfaces of equal amplitude of the vector field component Y of the electric field "e1".

' Plot only a wire frame of the structure to be able to look inside

Plot.wireframe (True)

' Select the Y-Component of the electric field e1 in the tree

SelectTreeItem ("2D/3D Results\E-Field\e1\Y")

' Enables plotting of 3D fields on 2D planes

Plot3DPlotsOn2DPlane (True)

' Plot the scalar field of the selected monitor

With ScalarPlot2D

    .Type ("isoline")

    .PlaneNormal ("x")

    .PlotAmplitude (False)

    .PlaneCoordinate (0.0)

    .Scaling (50)

    .LogScale (False)

    .ScaleToVectorMaximum (True)

    .Quality (60)

    .Plot 

End With