CSPropProbeBox

class CSXCAD.CSProperties.CSPropProbeBox

Bases: CSProperties

Probe propery.

Depending on the EM modeling tool there exist different probe types with different meanings.

openEMS probe types:

  • 0 : for voltage probing

  • 1 : for current probing

  • 2 : for E-field probing

  • 3 : for H-field probing

  • 10 : for waveguide voltage mode matching

  • 11 : for waveguide current mode matching

Parameters:

  • p_type – probe type (default is 0)

  • weight – weighting factor (default is 1)

  • frequency – dump in the frequency domain at the given samples (in Hz)

  • mode_function – A mode function (used only with probe type 10/11).

  • norm_dir – Necessary for current probing box with dimension not 2

AddFrequency(freq)
ClearFrequency()
GetFrequency()
GetFrequencyCount()
GetModeFile() → str
GetModeFunction() → list of 3 strings
GetModeOrigin() → [float, float, float]
GetNormalDir()
GetProbeType()
GetWeighting()
SetFrequency(freq)
SetModeFile(fileName)

Set an HDF5 file as the mode profile for this probe (alternative to SetModeFunction). Stored and serialized by CSXCAD; the coordinate evaluation and mode-matching is performed by the simulator.

Parameters:

fileName – str – path to the HDF5 mode file

SetModeFunction(mode_fun)

Set the spatial mode function strings for mode-matching (list of 3 strings, one per Cartesian component).

SetModeOrigin(origin)

Set the coordinate origin for mode function/file evaluation. Stored and serialized by CSXCAD; applied by the simulator during mode-matching integration.

Parameters:

origin – (3,) array – [x, y, z] in drawing units

SetNormalDir(val)
SetProbeType(val)
SetWeighting(val)