BendFieldNodesModification#

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

Bases: orbit.py_linac.lattice_modifications.errors_modifications_lib.ErrorForNodesModification

This class will apply the errors to the fields of the bends using energy shift

Methods Summary

`addBend`(bend)	Adds up bend node.
`addBends`(bends)	Adds up bend nodes array.
`getRelativeFieldChange`()	Returns the realtive change in the bend field.
`setGaussDistributedRelativeFieldError`(...[, ...])	Sets the random generated field error for all bends.
`setRelativeFieldChange`(relative_field_change)	Sets the realtive change in the bend field.
`updateErrorParameters`()	This is an implementation of parent class abstract method.

Methods Documentation

addBend(bend)[source]#: Adds up bend node.

addBends(bends)[source]#: Adds up bend nodes array.

getRelativeFieldChange()[source]#: Returns the realtive change in the bend field.

setGaussDistributedRelativeFieldError(relative_error, cut_off_level=3.0, comm=<MPI_Comm object>)[source]#: Sets the random generated field error for all bends. The same value for all registered bends.

setRelativeFieldChange(relative_field_change)[source]#: Sets the realtive change in the bend field.

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