PyPO.PyPOTypes.scalarfield Class Reference

Structure for storing scalar fields and associated metadata. More...

Inheritance diagram for PyPO.PyPOTypes.scalarfield:

Public Member Functions
def	__init__ (self, S)
	Constructor for scalar field. More...
def	setMeta (self, surf, k)
	Set scalar field metadata. More...
def	save (self, filename)
	Save a scalarfield object to a numpy compressed arrays (.npz) file. More...

Public Attributes
	S
	surf
	k

Detailed Description

Structure for storing scalar fields and associated metadata.

Constructor & Destructor Documentation

__init__()

def PyPO.PyPOTypes.scalarfield.__init__	(		self,
			S
	)

Constructor for scalar field.

Parameters

S	Scalar field.

Member Function Documentation

save()

def PyPO.PyPOTypes.scalarfield.save	(		self,
			filename
	)

Save a scalarfield object to a numpy compressed arrays (.npz) file.

Parameters

filename

The path and name of the file to save to.

setMeta()

def PyPO.PyPOTypes.scalarfield.setMeta	(		self,
			surf,
			k
	)

Set scalar field metadata.

Parameters

surf	Name of surface on which scalar field is defined.
k	Wavenumber in 1 / mm of scalar field.

---

The documentation for this class was generated from the following file:

• src/PyPO/PyPOTypes.py