TEAPOT_Lattice#

class orbit.teapot.TEAPOT_Lattice(name='no name')[source]#

Bases: orbit.lattice.AccLattice.AccLattice

The subclass of the AccLattice class. Shell class for the TEAPOT nodes collection. TEAPOT has the ability to read MAD files.

Methods Summary

getSubLattice([index_start, index_stop])

It returns the new TEAPOT_Lattice with children with indexes between index_start and index_stop inclusive

getUseRealCharge()

If useCharge != 1 the trackBunch(...) method will assume the charge = +1

initialize()

Method.

readMAD(mad_file_name, lineName)

It creates the teapot lattice from MAD file.

readMADX(madx_file_name, seqName)

It creates the teapot lattice from MAD file.

setUseRealCharge([useCharge])

If useCharge != 1 the trackBunch(...) method will assume the charge = +1

trackBunch(bunch[, paramsDict, ...])

It tracks the bunch through the lattice.

Methods Documentation

Parameters

name (str) –

Return type

None

getSubLattice(index_start=- 1, index_stop=- 1)[source]#

It returns the new TEAPOT_Lattice with children with indexes between index_start and index_stop inclusive

Parameters

  • index_start (int) –

  • index_stop (int) –

getUseRealCharge()[source]#

If useCharge != 1 the trackBunch(…) method will assume the charge = +1

Return type

int

initialize()[source]#

Method. Initializes the lattice and child node structures.

Return type

None

readMAD(mad_file_name, lineName)[source]#

It creates the teapot lattice from MAD file.

Return type

None

Parameters

  • mad_file_name (str) –

  • lineName (str) –

readMADX(madx_file_name, seqName)[source]#

It creates the teapot lattice from MAD file.

Return type

None

Parameters

  • madx_file_name (str) –

  • seqName (str) –

setUseRealCharge(useCharge=1)[source]#

If useCharge != 1 the trackBunch(…) method will assume the charge = +1

Return type

None

Parameters

useCharge (int) –

trackBunch(bunch, paramsDict={}, actionContainer=None, index_start=- 1, index_stop=- 1)[source]#

It tracks the bunch through the lattice. Indexes index_start and index_stop are inclusive.

Return type

None

Parameters