Plotter.py File Reference

File containing functions for generating plots. More...

Functions
def	PyPO.Plotter.plotBeam2D (plotObject, field, contour, vmin, vmax, levels, amp_only, norm, aperDict, scale, project, units, titleA, titleP, unwrap_phase)
	Generate a 2D plot of a field or current. More...
def	PyPO.Plotter.plot3D (plotObject, ax, fine, cmap, norm, foc1, foc2, plotSystem_f=False)
	Plot a 3D reflector. More...
def	PyPO.Plotter.plotSystem (systemDict, ax, fine, cmap, norm, foc1, foc2, RTframes, RTcolor)
	Plot the system. More...
def	PyPO.Plotter.plotBeamCut (x_cut, y_cut, x_strip, y_strip, vmin, vmax, units)
	Plot two beam cuts in the same figure. More...
def	PyPO.Plotter.plotRTframe (frame, project, savePath, returns, aspect, units)
	Plot a ray-trace frame spot diagram. More...

Detailed Description

File containing functions for generating plots.

Function Documentation

plot3D()

def PyPO.Plotter.plot3D	(		plotObject,
			ax,
			fine,
			cmap,
			norm,
			foc1,
			foc2,
			plotSystem_f = False
	)

Plot a 3D reflector.

Parameters

plotObject	A reflDict containing surface on which to plot beam.
ax	Axis to use for plotting.
fine	Spacing of normals for plotting.
cmap	Colormap of reflector.
norm	Plot reflector normals.
foc1	Plot focus 1.
foc2	Plot focus 2.
plotSystem_f	Whether or not plot3D is called from plotSystem.

plotBeam2D()

def PyPO.Plotter.plotBeam2D	(		plotObject,
			field,
			contour,
			vmin,
			vmax,
			levels,
			amp_only,
			norm,
			aperDict,
			scale,
			project,
			units,
			titleA,
			titleP,
			unwrap_phase
	)

Generate a 2D plot of a field or current.

Parameters

plotObject	A reflDict containing surface on which to plot beam.
field	PyPO field or current component to plot.
contour	A PyPO field or current component to plot as contour.
vmin	Minimum amplitude value to display. Default is -30.
vmax	Maximum amplitude value to display. Default is 0.
levels	Levels for contourplot.
amp_only	Only plot amplitude pattern. Default is False.
norm	Normalise field (only relevant when plotting linear scale).
aperDict	Plot an aperture defined in an aperDict object along with the field or current patterns. Default is None.
scale	Plot amplitude in decibels, logarithmic or linear scale. Instance of Scales enum object.
project	Set abscissa and ordinate of plot. Should be given as an instance of the Projection enum.
units	The units of the axes. Instance of Units enum object.
titleA	Title of the amplitude plot. Default is "Amp".
titleP	Title of the phase plot. Default is "Phase".
unwrap_phase	Unwrap the phase patter. Prevents annular structure in phase pattern. Default is False.

Returns

fig Figure object containing plot.

ax Axes containing the axes of the plot.

See also

aperDict

plotBeamCut()

def PyPO.Plotter.plotBeamCut	(		x_cut,
			y_cut,
			x_strip,
			y_strip,
			vmin,
			vmax,
			units
	)

Plot two beam cuts in the same figure.

Parameters

x_cut	E-plane.
y_cut	H-plane.
x_strip	Co-ordinates for plotting E-plane.
y_strip	Co-ordinates for plotting H-plane.
vmin	Minimum for plot range.
vmax	Maximum for plot range.
units	Unit for x-axis. Instance of Units enum object.

Returns

fig Plot figure.

ax Plot axis.

plotRTframe()

def PyPO.Plotter.plotRTframe	(		frame,
			project,
			savePath,
			returns,
			aspect,
			units
	)

Plot a ray-trace frame spot diagram.

Parameters

frame	A PyPO frame object.
project	Set abscissa and ordinate of plot. Should be given as an instance of the Projection enum.
savePath	Path to save plot to.
returns	Whether to return figure object.
aspect	Aspect ratio of plot.
units	Units of the axes for the plot. Instance of Units enum object.

plotSystem()

def PyPO.Plotter.plotSystem	(		systemDict,
			ax,
			fine,
			cmap,
			norm,
			foc1,
			foc2,
			RTframes,
			RTcolor
	)

Plot the system.

Parameters

systemDict	Dictionary containing the reflectors to be plotted.
ax	Axis of plot.
fine	Spacing of normals for plotting.
cmap	Colormap of reflector.
norm	Plot reflector normals.
foc1	Plot focus 1.
foc2	Plot focus 2.
RTframes	List containing frames to be plotted.