Efficiencies.py File Reference

File containing functions for calculating efficiencies and other metrics. More...

Functions
def	PyPO.Efficiencies.calcRTcenter (frame)
	Calculate the mean geometric center of a ray-trace frame. More...
def	PyPO.Efficiencies.calcRTtilt (frame)
	Calculate mean tilt of a ray-trace frame. More...
def	PyPO.Efficiencies.calcRMS (frame)
	Calculate root-mean-square (RMS) of a ray-trace frame. More...
def	PyPO.Efficiencies.calcSpillover (field, surfaceObject, aperDict)
	Calculate spillover efficiency of a field on an aperture. More...
def	PyPO.Efficiencies.calcTaper (field, surfaceObject, aperDict)
	Calculate taper efficiency of a field on an aperture. More...
def	PyPO.Efficiencies.calcXpol (Cofield, Xfield)
	Calculate cross-polar efficiency. More...
def	PyPO.Efficiencies.calcMainBeam (field, surfaceObject, fitGauss)
	Calculate main beam efficiency. More...

Detailed Description

File containing functions for calculating efficiencies and other metrics.

Function Documentation

calcMainBeam()

def PyPO.Efficiencies.calcMainBeam	(		field,
			surfaceObject,
			fitGauss
	)

Calculate main beam efficiency.

Parameters

field	Component of a fields object.
surfaceObject	Name of surface on which field is defined.
fitGauss	Gaussian fit to field.

Returns

eff_mb Main beam efficiency.

calcRMS()

def PyPO.Efficiencies.calcRMS

(

frame

)

Calculate root-mean-square (RMS) of a ray-trace frame.

Parameters

frame

Frame to calculate RMS of.

Returns

rms The RMS value of the frame.

calcRTcenter()

def PyPO.Efficiencies.calcRTcenter

(

frame

)

Calculate the mean geometric center of a ray-trace frame.

Parameters

frame

Frame to calculate center of.

Returns

center Array containing center xyz co-ordinates.

calcRTtilt()

def PyPO.Efficiencies.calcRTtilt

(

frame

)

Calculate mean tilt of a ray-trace frame.

Parameters

frame

Frame to calculate tilt of.

Returns

tilt Array containing xyz tilt components.

calcSpillover()

def PyPO.Efficiencies.calcSpillover	(		field,
			surfaceObject,
			aperDict
	)

Calculate spillover efficiency of a field on an aperture.

Parameters

field	Component of a fields object.
surfaceObject	Name of surface on which field is defined.
aperDict	Dictionary containing parameters for aperture for calculation.

Returns

eff_s Spillover efficiency

calcTaper()

def PyPO.Efficiencies.calcTaper	(		field,
			surfaceObject,
			aperDict
	)

Calculate taper efficiency of a field on an aperture.

Parameters

field	Component of a fields object.
surfaceObject	Name of surface on which field is defined.
aperDict	Dictionary containing parameters for aperture for calculation.

Returns

eff_t Taper efficiency

calcXpol()

def PyPO.Efficiencies.calcXpol	(		Cofield,
			Xfield
	)

Calculate cross-polar efficiency.

Parameters

Cofield	Co-polarised field component.
Xfield	Cross-polarised field component.

Returns

eff_Xpol Cross-polar efficiency.