PyPO User Manual
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...
 

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
SScalar field.

Member Function Documentation

◆ setMeta()

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

Set scalar field metadata.

Parameters
surfName of surface on which scalar field is defined.
kWavenumber in 1 / mm of scalar field.

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