formData.py File Reference

This file contains all forms used by the GUI for interaction with the user. More...

Functions
def	GUI.ParameterForms.formData.surface_error ()
	Options for adding surface error.
def	GUI.ParameterForms.formData.xy_opts ()
	Options for generating an element from an xy parametrisation.
def	GUI.ParameterForms.formData.uv_opts ()
	Options for generating an element from a uv parametrisation.
def	GUI.ParameterForms.formData.AoE_opts ()
	Options for generating a far-field element from an AoE (Azimuth-over-Elevation) parametrisation.
def	GUI.ParameterForms.formData.focus_opts_hyp_ell ()
	Extra options for hyperboloids and ellipsoids for supplying quadric parameters and gridding options.
def	GUI.ParameterForms.formData.makeParabolaInp ()
	Form for generating a paraboloid element.
def	GUI.ParameterForms.formData.makeHyperbolaInp ()
	Form for generating a hyperboloid element.
def	GUI.ParameterForms.formData.makeEllipseInp ()
	Form for generating an ellipsoid element.
def	GUI.ParameterForms.formData.makeQuadricSurfaceInp ()
	Menu for generating quadric elements.
def	GUI.ParameterForms.formData.makePlaneInp ()
	Menu for generating planar elements.
def	GUI.ParameterForms.formData.makeTransformationForm (name, obj="element")
	Options for transforming elements and groups. More...
def	GUI.ParameterForms.formData.initTubeFrameInp ()
	Options for generating a tubular ray-trace frame.
def	GUI.ParameterForms.formData.initGaussianFrameInp ()
	Options for generating a Gaussian ray-trace frame.
def	GUI.ParameterForms.formData.plotFrameOpt (frameName)
	Options for plotting a ray-trace frame. More...
def	GUI.ParameterForms.formData.plotRayTraceForm (frames)
	Options for plotting a set of frames in a plotSystem figure. More...
def	GUI.ParameterForms.formData.propRaysInp (frameDict, elemDict)
	Options for propagating a frame of rays to a target element. More...
def	GUI.ParameterForms.formData.initPSInp (elemDict)
	Options for generating a vectorial point-source field/current for PO calculations. More...
def	GUI.ParameterForms.formData.initSPSInp (elemDict)
	Options for generating a scalar point-source field for PO calculations. More...
def	GUI.ParameterForms.formData.initGaussianInp (elemDict)
	Options for generating a vectorial complex-valued Gaussian field/current for PO calculations. More...
def	GUI.ParameterForms.formData.initSGaussianInp (elemDict)
	Options for generating a scalar complex-valued Gaussian field for PO calculations. More...
def	GUI.ParameterForms.formData.plotField (fieldName)
	Options for plotting a field object. More...
def	GUI.ParameterForms.formData.plotSField (fieldName)
	Options for plotting a scalarfield object. More...
def	GUI.ParameterForms.formData.plotFarField (fieldName)
	Options for plotting a field object defined on a far-field grid. More...
def	GUI.ParameterForms.formData.plotCurrentOpt (currentName)
	Options for plotting a current object. More...
def	GUI.ParameterForms.formData.propPOInp (currentDict, scalarFieldDict, elemDict)
	Options for propagating the field generated by a current distribution to a target element. More...
def	GUI.ParameterForms.formData.propPOFFInp (currentDict, elemDict)
	Options for propagating the field generated by a current distribution to a far-field target element. More...
def	GUI.ParameterForms.formData.propPOHybridInp (fieldDict, frameDict, elemDict)
	Options for propagating the reflected field using the associated Poynting vectors to a target element. More...
def	GUI.ParameterForms.formData.calcSpillEff (fieldDict, elemDict)
	Options for calculating the spillover efficiency on a surface by using an aperture mask. More...
def	GUI.ParameterForms.formData.calcTaperEff (fieldDict, elemDict)
	Options for calculating the taper efficiency on a planar surface. More...
def	GUI.ParameterForms.formData.calcXpolEff (fieldDict, elemDict)
	Options for calculating the cross-polar efficiency on a far-field element. More...
def	GUI.ParameterForms.formData.calcMBEff (fieldDict, elemDict)
	Options for calculating the main-beam efficiency on a planar element. More...
def	GUI.ParameterForms.formData.calcHPBW (fieldDict)
	Options for calculating the half-power beamwidths of a field component in the E and H-planes. More...
def	GUI.ParameterForms.formData.mergeBeamsForm (itemDict, surf)
	Options for merging beams/currents. More...
def	GUI.ParameterForms.formData.selectSurface (elemDict)
	Select a surface form. More...
def	GUI.ParameterForms.formData.saveSystemForm ()
	Options for saving the current system in the PyPO/save/systems/ folder.
def	GUI.ParameterForms.formData.loadSystemForm (systemList)
	Options for loading a system in the PyPO/save/systems/ folder into the current system. More...
def	GUI.ParameterForms.formData.focusFind (frameList)
	Options for finding the focus of a ray-trace frame. More...
def	GUI.ParameterForms.formData.snapForm (elem, snapList, obj="element")
	Options for taking/reverting/deleting a snapshot of an object. More...
def	GUI.ParameterForms.formData.addGroupForm (elementList)
	Options for creating a group of elements. More...
def	GUI.ParameterForms.formData.copyForm (name)
	Options for copying an object to another object, potentially under a new name. More...

Variables
list	GUI.ParameterForms.formData.FieldComponentList = [o for o in FieldComponents]
list	GUI.ParameterForms.formData.FieldComponentListStrings = [do.name for do in FieldComponentList]
list	GUI.ParameterForms.formData.CurrentComponentList = [o for o in CurrentComponents]
list	GUI.ParameterForms.formData.CurrentComponentListStrings = [do.name for do in CurrentComponents]

Detailed Description

This file contains all forms used by the GUI for interaction with the user.

Because all functions return lists containing forms, the return will not be explicitly stated per form.

Function Documentation

addGroupForm()

def GUI.ParameterForms.formData.addGroupForm

(

elementList

)

Options for creating a group of elements.

Parameters

elementList

List of all element names.

calcHPBW()

def GUI.ParameterForms.formData.calcHPBW

(

fieldDict

)

Options for calculating the half-power beamwidths of a field component in the E and H-planes.

The field component is first transformed so that it is centered in the origin and aligned with the x and y axes.

Parameters

fieldDict

System dictionary containing all fields.

calcMBEff()

def GUI.ParameterForms.formData.calcMBEff	(		fieldDict,
			elemDict
	)

Options for calculating the main-beam efficiency on a planar element.

Parameters

fieldDict	System dictionary containing all fields.
elemDict	System dictionary containing all elements.

calcSpillEff()

def GUI.ParameterForms.formData.calcSpillEff	(		fieldDict,
			elemDict
	)

Options for calculating the spillover efficiency on a surface by using an aperture mask.

Parameters

fieldDict	System dictionary containing all fields.
elemDict	System dictionary containing all elements.

calcTaperEff()

def GUI.ParameterForms.formData.calcTaperEff	(		fieldDict,
			elemDict
	)

Options for calculating the taper efficiency on a planar surface.

Parameters

fieldDict	System dictionary containing all fields.
elemDict	System dictionary containing all elements.

calcXpolEff()

def GUI.ParameterForms.formData.calcXpolEff	(		fieldDict,
			elemDict
	)

Options for calculating the cross-polar efficiency on a far-field element.

Parameters

fieldDict	System dictionary containing all fields.
elemDict	System dictionary containing all elements.

copyForm()

def GUI.ParameterForms.formData.copyForm

(

name

)

Options for copying an object to another object, potentially under a new name.

Parameters

name	Name of object to be copied.

focusFind()

def GUI.ParameterForms.formData.focusFind

(

frameList

)

Options for finding the focus of a ray-trace frame.

Parameters

frameList

List of names of frames in system.

initGaussianInp()

def GUI.ParameterForms.formData.initGaussianInp

(

elemDict

)

Options for generating a vectorial complex-valued Gaussian field/current for PO calculations.

Parameters

elemDict

System dictionary containing all elements.

initPSInp()

def GUI.ParameterForms.formData.initPSInp

(

elemDict

)

Options for generating a vectorial point-source field/current for PO calculations.

Parameters

elemDict

System dictionary containing all elements.

initSGaussianInp()

def GUI.ParameterForms.formData.initSGaussianInp

(

elemDict

)

Options for generating a scalar complex-valued Gaussian field for PO calculations.

Parameters

elemDict

System dictionary containing all elements.

initSPSInp()

def GUI.ParameterForms.formData.initSPSInp

(

elemDict

)

Options for generating a scalar point-source field for PO calculations.

Parameters

elemDict

System dictionary containing all elements.

loadSystemForm()

def GUI.ParameterForms.formData.loadSystemForm

(

systemList

)

Options for loading a system in the PyPO/save/systems/ folder into the current system.

Parameters

systemList

List of systems present in PyPO/save/systems/.

makeTransformationForm()

def GUI.ParameterForms.formData.makeTransformationForm	(		name,
			obj = "element"
	)

Options for transforming elements and groups.

Also used for transforming frames.

Parameters

name	Name of element/group/frame in system.
obj	Type of object to transform. Defaults to "element".

mergeBeamsForm()

def GUI.ParameterForms.formData.mergeBeamsForm	(		itemDict,
			surf
	)

Options for merging beams/currents.

Parameters

itemDict	Dictionary containing fields or currents in system.
surf	Selected surface for beam merging.

plotCurrentOpt()

def GUI.ParameterForms.formData.plotCurrentOpt

(

currentName

)

Options for plotting a current object.

Parameters

fieldName

Name of current object to plot.

plotFarField()

def GUI.ParameterForms.formData.plotFarField

(

fieldName

)

Options for plotting a field object defined on a far-field grid.

Also contains possibility for plotting beam cross sections.

Parameters

fieldName

Name of field object to plot.

plotField()

def GUI.ParameterForms.formData.plotField

(

fieldName

)

Options for plotting a field object.

Also contains possibility for plotting beam cross sections.

Parameters

fieldName

Name of field object to plot.

plotFrameOpt()

def GUI.ParameterForms.formData.plotFrameOpt

(

frameName

)

Options for plotting a ray-trace frame.

Parameters

frameName

Name of frame to plot.

plotRayTraceForm()

def GUI.ParameterForms.formData.plotRayTraceForm

(

frames

)

Options for plotting a set of frames in a plotSystem figure.

Parameters

frames

List containing names of available frames.

plotSField()

def GUI.ParameterForms.formData.plotSField

(

fieldName

)

Options for plotting a scalarfield object.

Parameters

fieldName

Name of field object to plot.

propPOFFInp()

def GUI.ParameterForms.formData.propPOFFInp	(		currentDict,
			elemDict
	)

Options for propagating the field generated by a current distribution to a far-field target element.

Parameters

currentDict	System dictionary containing all currents.
elemDict	System dictionary containing all elements.

propPOHybridInp()

def GUI.ParameterForms.formData.propPOHybridInp	(		fieldDict,
			frameDict,
			elemDict
	)

Options for propagating the reflected field using the associated Poynting vectors to a target element.

Parameters

fieldDict	System dictionary containing all fields.
frameDict	System dictionary containing all frames.
elemDict	System dictionary containing all elements.

propPOInp()

def GUI.ParameterForms.formData.propPOInp	(		currentDict,
			scalarFieldDict,
			elemDict
	)

Options for propagating the field generated by a current distribution to a target element.

If propagating a scalarfield, the propagation is done using the Lipmann-Schwinger equation.

Parameters

currentDict	System dictionary containing all currents.
scalarFieldDict	System dictionary containing all scalarfields.
elemDict	System dictionary containing all elements.

propRaysInp()

def GUI.ParameterForms.formData.propRaysInp	(		frameDict,
			elemDict
	)

Options for propagating a frame of rays to a target element.

Parameters

frameDict	System dictionary containing all frames.
elemDict	System dictionary containing all elements.

selectSurface()

def GUI.ParameterForms.formData.selectSurface

(

elemDict

)

Select a surface form.

Used for merging beams on a surface.

Parameters

elemDict

Dictionary containing all elements in system.

snapForm()

def GUI.ParameterForms.formData.snapForm	(		elem,
			snapList,
			obj = "element"
	)

Options for taking/reverting/deleting a snapshot of an object.

Parameters

elem	Name of object to snap.
snapList	List of current snapshots belonging to the object.
obj	Type of object to be snapped.