CoordinateDisplacementNodesModification#

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

Bases: orbit.py_linac.lattice_modifications.errors_modifications_lib.ErrorForNodesModification

This class applies the coordinate displacement errors to the set of nodes. The parameters of displacements are translated 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

`getCoordinateDisplacementParameters`()	Returns tuple with coordinate shift parameters.
`setDisplacementParameter`(key, value)	Sets the error value for a particular coordinate for all nodes.
`setGaussDistributedDisplacementParameter`(...)	Sets the random generated error value for a particular coordinate for all nodes.
`updateErrorParameters`()	This is an implementation of parent class abstract method.

Methods Documentation

getCoordinateDisplacementParameters()[source]#: Returns tuple with coordinate shift parameters.

setDisplacementParameter(key, value)[source]#: Sets the error value for a particular coordinate for all nodes. The cooridinate is defined by key parameter.

setGaussDistributedDisplacementParameter(key, value, cut_off_level=3.0, comm=<MPI_Comm object>)[source]#: Sets the random generated error value for a particular coordinate for all nodes. The cooridinate is defined by key parameter.

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