PyPOTypes.py File Reference

Classes
class	PyPO.PyPOTypes.resContainer
	Base class for EH fields and JM currents. More...
class	PyPO.PyPOTypes.currents
	Wrapper for making a currents object. More...
class	PyPO.PyPOTypes.fields
	Wrapper for making a fields object. More...
class	PyPO.PyPOTypes.rfield
	Class for making a real-vaLuad 3D object, used for Poynting vectors. More...
class	PyPO.PyPOTypes.scalarfield
	Structure for storing scalar fields and associated metadata. More...
class	PyPO.PyPOTypes.reflGrids
	Structure for storing reflector grids, area and normals. More...
class	PyPO.PyPOTypes.frame
	Structure for storing ray-trace frames. More...

Functions
def	PyPO.PyPOTypes.load_currents (filename)
	Create a currents object from a numpy arrays (.npz) file. More...
def	PyPO.PyPOTypes.load_fields (filename)
	Create a field object from a numpy compressed arrays (.npz) file. More...
def	PyPO.PyPOTypes.load_rfield (filename)
	Create a rfield object from a numpy arrays (.npz) file. More...
def	PyPO.PyPOTypes.load_scalarfield (filename)
	Create a scalarfield object from a numpy arrays (.npz) file. More...
def	PyPO.PyPOTypes.load_grid (filename)
	Create a grid object from a numpy arrays (.npz) file. More...
def	PyPO.PyPOTypes.load_frame (filename)
	Create a grid object from a numpy arrays (.npz) file. More...

Detailed Description

Definitions of PyPO data structures.

Function Documentation

load_currents()

def PyPO.PyPOTypes.load_currents

(

filename

)

Create a currents object from a numpy arrays (.npz) file.

Parameters

filename

The path and name of the file to load.

load_fields()

def PyPO.PyPOTypes.load_fields

(

filename

)

Create a field object from a numpy compressed arrays (.npz) file.

Parameters

filename

The path and name of the file to load.

load_frame()

def PyPO.PyPOTypes.load_frame

(

filename

)

Create a grid object from a numpy arrays (.npz) file.

Parameters

filename

The path and name of the file to load.

load_grid()

def PyPO.PyPOTypes.load_grid

(

filename

)

Create a grid object from a numpy arrays (.npz) file.

Parameters

filename

The path and name of the file to load.

load_rfield()

def PyPO.PyPOTypes.load_rfield

(

filename

)

Create a rfield object from a numpy arrays (.npz) file.

Parameters

filename

The path and name of the file to load.

load_scalarfield()

def PyPO.PyPOTypes.load_scalarfield

(

filename

)

Create a scalarfield object from a numpy arrays (.npz) file.

Parameters

filename

The path and name of the file to load.