PyPO User Manual
PyPO.PyPOTypes.frame Class Reference

Structure for storing ray-trace frames. More...

Inheritance diagram for PyPO.PyPOTypes.frame:

Public Member Functions

def __init__ (self, size, x, y, z, dx, dy, dz)
 Constructor. More...
 
def setMeta (self, pos, ori, transf)
 Set frame metadata. More...
 

Public Attributes

 size
 
 x
 
 y
 
 z
 
 dx
 
 dy
 
 dz
 
 snapshots
 
 pos
 
 ori
 
 transf
 

Detailed Description

Structure for storing ray-trace frames.

Constructor & Destructor Documentation

◆ __init__()

def PyPO.PyPOTypes.frame.__init__ (   self,
  size,
  x,
  y,
  z,
  dx,
  dy,
  dz 
)

Constructor.

Takes frame points and directions and stores them.

Parameters
sizeNumber of rays in frame.
xThe x-components of the rays in the frame.
yThe y-components of the rays in the frame.
zThe z-components of the rays in the frame.
dxThe x-components of the direction of the rays in the frame.
dyThe y-components of the direction of the rays in the frame.
dzThe z-components of the direction of the rays in the frame.

Member Function Documentation

◆ setMeta()

def PyPO.PyPOTypes.frame.setMeta (   self,
  pos,
  ori,
  transf 
)

Set frame metadata.

Parameters
posCo-ordinate of reference point of frame..
oriReference orientation of frame.
transfTransformation matrix for the frame.

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