orbit.matrix_lattice.BaseMATRIX#

class orbit.matrix_lattice.BaseMATRIX(name='no name')[source]#

The base abstract class of the BaseMATRIX accelerator lattice elements hierarchy.

__init__(name='no name')[source]#

Constructor. Creates the base MATRIX element.

Methods

__init__([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.

getLength([index])

Method.

getMatrix()

Returns the (7,7) Matrix for this transport AccNode.

getName()

Method.

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.

getType()

Method.

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.

setLength([L, index])

Method.

setName([name])

Method.

setParam(key, value)

Method.

setParamsDict(params)

Method.

setType([type_in])

Method.

setnParts([n])

Method.

structureToText([txt, txt_shift])

This method write the structure of the node to the text variable recursively.

track(paramsDict)

It is tracking the parameter dictionary (with bunch as a "bunch") through the BaseMATRIX element.

trackActions(actionsContainer[, paramsDict])

Method.

trackBunch(bunch[, paramsDict, actionContainer])

It tracks the bunch through the AccNodeBunchTracker instance.

updateParamsDict(params)

Method.

Attributes

AFTER

BEFORE

BODY

ENTRANCE

EXIT