LinacApertureNode#

class orbit.py_linac.lattice.LinacApertureNode(shape, a, b, pos=0.0, c=0.0, d=0.0, name='aperture')[source]#

Bases: orbit.py_linac.lattice.LinacAccNodes.BaseLinacNode

The aperture classes removes particles from bunch and places them in the lostbunch if their coordinates are not inside the aperture: The shape variable could be: 1 is circle (a is a radius) 2 is elipse (a and b are a half-axises) 3 is rectangle (a and b are a half-horizontal and vertical sizes) c and d parameters are x and y offsets of the center

Methods Summary

getBaseAperture()

Retirns BaseAperture that allow accsess to aperture shape through getApertureShape, or replacing the shape with setApertureShape(newApertureShape)

getNumberOfLostParticles()

setName([name])

Method.

setPosition(pos)

Sets the position of the node inside the sequence.

track(paramsDict)

It is tracking the bunch through the element.

trackDesign(paramsDict)

This method does nothing for the aperture case.

Methods Documentation

getBaseAperture()[source]#

Retirns BaseAperture that allow accsess to aperture shape through getApertureShape, or replacing the shape with setApertureShape(newApertureShape)

getNumberOfLostParticles()[source]#
setName(name='no name')[source]#

Method. Sets the name.

setPosition(pos)[source]#

Sets the position of the node inside the sequence. If the node has non-zero length, the position is usually at the center.

track(paramsDict)[source]#

It is tracking the bunch through the element. Each element should implement this method.

trackDesign(paramsDict)[source]#

This method does nothing for the aperture case.