Special Option Arguments

Here you can find information on the special options PyPO that can be passed as arguments to functions. More...

Classes
class	PyPO.Enums.FieldComponents
	Enum types for electric and magnetic field components. More...
class	PyPO.Enums.CurrentComponents
	These are special options that are used whenever a specific component of a field or current distribution is required. More...
class	PyPO.Enums.Projections
	Enum types for projections on two axes for plotting purposes. More...
class	PyPO.Enums.Units
	Enum types for units for display and conversion. More...
class	PyPO.Enums.Modes
	Enum types for units for setting scaling mode for quantities. More...
class	PyPO.Enums.AperShapes
	Enum types for aperture object shapes. More...

Detailed Description

Here you can find information on the special options PyPO that can be passed as arguments to functions.

Several PyPO functions expect special arguments. For example, plotting a field or current distribution usually involves selecting a plane on which to project the object for visualisation. Also, for polarised fields and currents, the component of the field needs to be specified. What makes these special is the fact that only a few options are allowed per argument, but between the available options, the choice is free. PyPO provides built-in enumerable types that contain the special options. These can be imported and used as inpit to functions that require one.