orbit.foils.TeapotFoilNode#
- class orbit.foils.TeapotFoilNode(xmin, xmax, ymin, ymax, thick, name='foil no name')[source]#
The foil node class for TEAPOT lattice
- __init__(xmin, xmax, ymin, ymax, thick, name='foil no name')[source]#
Constructor. Creates the Foil TEAPOT element.
Methods
__init__(xmin, xmax, ymin, ymax, thick[, name])Constructor.
addChildNode(node, place[, part_index, ...])Method.
addParam(key, value)Method.
getActivePartIndex()Method.
getAllChildren()It returns the list of all children of this node.
getBodyChildren()Returns the array of direct childrens of this accelerator node that are inside the element, not before or after.
getChildNodes(place[, part_index, place_in_part])Method.
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.
getLength([index])Method.
getName()Method.
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
getNumberOfBodyChildren()Returns the total number of direct childrens of this accelerator node that are inside the element, not before or after.
getNumberOfChildren()Returns the total number of direct children of this accelerator node.
getParam(key)Method.
getParamsDict()Method.
getTiltAngle()Returns the tilt angle for the tilt operation.
getType()Method.
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.
getnParts()Method.
hasParam(key)Method.
initialize()Abstract method.
keys()return the list of the keys for the parameters
removeParam(key)Method.
reverseOrder()This method is used for a lattice reversal and a bunch backtracking.
reverseOrderNodeSpecific()This method is used for a lattice reversal and a bunch backtracking This is a node type specific method.
setActivePartIndex(activePartIndex)Method.
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.
setLength([L, index])Method.
setName([name])Method.
setParam(key, value)Method.
setParamsDict(params)Method.
setScatterChoice(choice)setTiltAngle([angle])Sets the tilt angle for the tilt operation.
setType([type_in])Method.
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.
setnParts([n])Method.
structureToText([txt, txt_shift])This method write the structure of the node to the text variable recursively.
track(paramsDict)The foil-teapot class implementation of the AccNodeBunchTracker class track(probe) method.
trackActions(actionsContainer[, paramsDict])Method.
trackBunch(bunch[, paramsDict, actionContainer])It tracks the bunch through the AccNodeBunchTracker instance.
updateParamsDict(params)Method.
Attributes
AFTERBEFOREBODYENTRANCEEXIT