LongitudinalDisplacementNodesModification#

class orbit.py_linac.lattice_modifications.LongitudinalDisplacementNodesModification(name='no_name')[source]#

Bases: orbit.py_linac.lattice_modifications.errors_modifications_lib.ErrorForNodesModification

This class shifts lattice nodes in longitudinal directions. The shift length is sent to all error controllers. It could be fixed (all nodes will have the same displacement) or random values distributed around 0. by Gaussian with one sigma.

Methods Summary

`getShiftLength`()	Returns the shift-length parameter.
`setGaussDistributedShiftLength`(shift_length)	Sets the random generated error shift_length for all nodes.
`setShiftLength`(shift_length)	Sets the shift-length parameter.
`updateErrorParameters`()	This is an implementation of parent class abstract method.

Methods Documentation

getShiftLength()[source]#: Returns the shift-length parameter.

setGaussDistributedShiftLength(shift_length, cut_off_level=3.0, comm=<MPI_Comm object>)[source]#: Sets the random generated error shift_length for all nodes.

setShiftLength(shift_length)[source]#: Sets the shift-length parameter.

updateErrorParameters()[source]#: This is an implementation of parent class abstract method. It updates the error defining parameters for all registered error controllers.