LinacMagnetNode#

class orbit.py_linac.lattice.LinacMagnetNode(name='none')[source]#

Bases: orbit.py_linac.lattice.LinacAccNodes.LinacNode

The abstract class of the linac magnet.

Methods Summary

`getField`()	Returns the field value for the magnet.
`getFringeFieldFunctionIN`([trackFunction])	Returns the fringe field function that will track the bunch through the fringe at the entrance of the node.
`getFringeFieldFunctionOUT`([trackFunction])	Returns the fringe field function that will track the bunch through the fringe at the exit of the element.
`getNodeFringeFieldIN`()	Returns the FringeField instance before this node
`getNodeFringeFieldOUT`()	Returns the FringeField instance after this node
`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.
`setField`(field)	Sets the field value for the magnet.
`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.
`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

getField()[source]#: Returns the field value for the magnet. Abstract method. It should be implemented in the subclass.

getFringeFieldFunctionIN(trackFunction=None)[source]#: Returns the fringe field function that will track the bunch through the fringe at the entrance of the node.

getFringeFieldFunctionOUT(trackFunction=None)[source]#: Returns the fringe field function that will track the bunch through the fringe at the exit of the element.

getNodeFringeFieldIN()[source]#: Returns the FringeField instance before this node

getNodeFringeFieldOUT()[source]#: Returns the FringeField instance after this node

getUsageFringeFieldIN()[source]#: Returns the property describing if the IN fringe field will be used in calculation.

getUsageFringeFieldOUT()[source]#: Returns the property describing if the OUT fringe field will be used in calculation.

setField(field)[source]#: Sets the field value for the magnet. Abstract method. It should be implemented in the subclass.

setFringeFieldFunctionIN(trackFunction=None)[source]#: Sets the fringe field function that will track the bunch through the fringe at the entrance of the node.

setFringeFieldFunctionOUT(trackFunction=None)[source]#: Sets the fringe field function that will track the bunch through the fringe at the exit of the element.

setUsageFringeFieldIN(usage=True)[source]#: Sets the property describing if the IN fringe field will be used in calculation.

setUsageFringeFieldOUT(usage=True)[source]#: Sets the property describing if the OUT fringe field will be used in calculation.