Templates.py File Reference

Variables
dictionary	PyPO.Templates.reflDict
	Template for a reflDict, containing reflector parameters. More...
dictionary	PyPO.Templates.TubeRTDict
	Template for a TubeRTDict, containing parameters for constructing a tubular ray-trace frame. More...
dictionary	PyPO.Templates.GRTDict
	Template for a GRTDict, containing parameters for constructing a Gaussian ray-trace frame. More...
dictionary	PyPO.Templates.GPODict
	Template for a GPODict, containing parameters for constructing a Gaussian E field and associated magnetic currents. More...
dictionary	PyPO.Templates.vecGPODict
	Template for a VecPODict, containing parameters for constructing a symmetric vectorial Gaussian beam using the complex source point method. More...
dictionary	PyPO.Templates.PSDict
	Template for a point source dictionary. More...
dictionary	PyPO.Templates.aperDict
	Template for an aperture dictionary. More...
dictionary	PyPO.Templates.runPODict
	Template for a physical optics propagation dictionary. More...
dictionary	PyPO.Templates.runRTDict
	Template for a ray-trace propagation dictionary. More...
dictionary	PyPO.Templates.hybridDict
	Template for a hybrid RT/PO propagation. More...

Detailed Description

Templates for commonly used PyPO dictionaries.

For each key, a short summary of the key is given.

Variable Documentation

vecGPODict

dictionary PyPO.Templates.vecGPODict

Initial value:

=  {
        "name"      : "Name of Gaussian beam",
        "lam"       : "Wavelength of Gaussian beam in mm (positive real)",
        "w0"        : "Focal beamwaist of beam along x-axis in mm (positive real). Calculated from `w`, `z`, `R` if two are set.",
        "z"         : "Set the distance z along the beam that wx is defined at (real). Defaults to zero. Calculated from `w0`, `w`, `R` if two are set.",
        "w"         : "Beam radius at some distance `z` along the beam (positive real). Calculated from `w0`, `z`, `R` if two are set.",
        "R"         : "Radius of phase curvature in the x direction (real). Calculated from `w0`, `w`, `z` if any pair are set. Ignored if <0.01 `lam`.",
        "n"         : "Refractive index of medium. Defaults to 1.0.",
        "power"     : "Total power contained in the beam (real). Defaults to 4pi if not set.",
        "mode"      : "Mode to create beam in. One of 'full', 'PEC', 'PMC'"
        }

Template for a VecPODict, containing parameters for constructing a symmetric vectorial Gaussian beam using the complex source point method.

This template defines a vectorial Gaussian beam propagating along the positive z-axis, with the primary E-field polarized along the positive x-axis. Unless specified, the power in the beam is normalized to 4pi √W (this ensures that the farfields are in dBi).