NodeTEAPOT

class orbit.teapot.NodeTEAPOT(name='no name')

Bases: BaseTEAPOT

Methods Summary

getFringeFieldFunctionIN()	Returns the fringe field function that will track the bunch through the fringe at the entrance of the node.
getFringeFieldFunctionOUT()	Returns the fringe field function that will track the bunch through the fringe at the exit of the element.
getNodeFringeFieldIN()	Returns the FringeFieldTEAPOT instance before this TEAPOT node
getNodeFringeFieldOUT()	Returns the FringeFieldTEAPOT instance after this TEAPOT node
getNodeTiltIN()	Returns the TiltTEAPOT instance before this TEAPOT node
getNodeTiltOUT()	Returns the TiltTEAPOT instance after this TEAPOT node
getTiltAngle()	Returns the tilt angle for the tilt operation.
getUsageFringeFieldIN()	Returns the property describing if the IN fringe field will be used in calculation.
getUsageFringeFieldOUT()	Returns the property describing if the OUT fringe field will be used in calculation.
setFringeFieldFunctionIN([trackFunction])	Sets the fringe field function that will track the bunch through the fringe at the entrance of the node.
setFringeFieldFunctionOUT([trackFunction])	Sets the fringe field function that will track the bunch through the fringe at the exit of the element.
setTiltAngle([angle])	Sets the tilt angle for the tilt operation.
setUsageFringeFieldIN([usage])	Sets the property describing if the IN fringe field will be used in calculation.
setUsageFringeFieldOUT([usage])	Sets the property describing if the OUT fringe field will be used in calculation.

Methods Documentation

Parameters:

name (str)

getFringeFieldFunctionIN()

Returns the fringe field function that will track the bunch through the fringe at the entrance of the node.

Return type:

Callable

getFringeFieldFunctionOUT()

Returns the fringe field function that will track the bunch through the fringe at the exit of the element.

Return type:

Callable

getNodeFringeFieldIN()

Returns the FringeFieldTEAPOT instance before this TEAPOT node

Return type:

FringeFieldTEAPOT

getNodeFringeFieldOUT()

Returns the FringeFieldTEAPOT instance after this TEAPOT node

Return type:

FringeFieldTEAPOT

getNodeTiltIN()

Returns the TiltTEAPOT instance before this TEAPOT node

Return type:

TiltTEAPOT

getNodeTiltOUT()

Returns the TiltTEAPOT instance after this TEAPOT node

Return type:

TiltTEAPOT

getTiltAngle()

Returns the tilt angle for the tilt operation.

Return type:

float

getUsageFringeFieldIN()

Returns the property describing if the IN fringe field will be used in calculation.

Return type:

bool

getUsageFringeFieldOUT()

Returns the property describing if the OUT fringe field will be used in calculation.

Return type:

bool

setFringeFieldFunctionIN(trackFunction=None)

Sets the fringe field function that will track the bunch through the fringe at the entrance of the node.

Return type:

None

Parameters:

trackFunction (Callable)

setFringeFieldFunctionOUT(trackFunction=None)

Sets the fringe field function that will track the bunch through the fringe at the exit of the element.

Return type:

None

Parameters:

trackFunction (Callable)

setTiltAngle(angle=0.0)

Sets the tilt angle for the tilt operation.

Return type:

None

Parameters:

angle (float)

setUsageFringeFieldIN(usage=True)

Sets the property describing if the IN fringe field will be used in calculation.

Return type:

None

Parameters:

usage (bool)

setUsageFringeFieldOUT(usage=True)

Sets the property describing if the OUT fringe field will be used in calculation.

Return type:

None

Parameters:

usage (bool)