SNS_LinacLatticeFactory#

class orbit.py_linac.linac_parsers.SNS_LinacLatticeFactory[source]#

Bases: object

The SNS Linac Lattice Factory generates the Linac Accelerator Lattice from the XML file of the specific structure.

Methods Summary

`filterSequences_and_OptionalCheck`(...)	This method will filter the sequences according to names list and check the order of sequences in names.
`getLinacAccLattice`(names, xml_file_name)	Returns the linac accelerator lattice for specified sequence names and for a specified XML file.
`getLinacAccLatticeFromDA`(names, acc_da)	Returns the linac accelerator lattice for specified sequence names.
`getMaxDriftLength`()	Returns the maximal drift length that is used for the purpose of the space charge calculations and diagnostics.
`makeDA_bend`(seq_da, bend)	This method will fill out the DataAdaptor for a bend linac accelerator node.
`makeDA_dcorrH`(seq_da, dcorr)	This method will fill out the DataAdaptor for a DCorrectorH linac accelerator node.
`makeDA_dcorrV`(seq_da, dcorr)	This method will fill out the DataAdaptor for a DCorrectorV linac accelerator node.
`makeDA_marker`(seq_da, marker)
`makeDA_quad`(seq_da, quad)	This method will fill out the DataAdaptor for a quad linac accelerator node.
`makeDA_rf_gap`(seq_da, rf_gap)	This method will fill out the DataAdaptor for a RF Gap linac accelerator node.
`makeDAforAccSeq`(acc_da, accSeq)	This method adds the accelerator sequence data to accelerator data adaptor.
`makeDataAdaptorforLinacLattice`(linacAccLattice)	This method generates and returns the accelerator data adaptor for the accelerator lattice.
`setMaxDriftLength`([maxDriftLength])	Sets the maximal drift length that is used for the purpose of the space charge calculations and diagnostics.

Methods Documentation

filterSequences_and_OptionalCheck(accSeq_da_arr, names)[source]#: This method will filter the sequences according to names list and check the order of sequences in names. All sequences should be in the right order. For SNS linac is just a linac. It returns the filtered array with data adapters with the names in the names array.

getLinacAccLattice(names, xml_file_name)[source]#: Returns the linac accelerator lattice for specified sequence names and for a specified XML file.

getLinacAccLatticeFromDA(names, acc_da)[source]#: Returns the linac accelerator lattice for specified sequence names.

getMaxDriftLength()[source]#: Returns the maximal drift length that is used for the purpose of the space charge calculations and diagnostics.

makeDA_bend(seq_da, bend)[source]#: This method will fill out the DataAdaptor for a bend linac accelerator node.

makeDA_dcorrH(seq_da, dcorr)[source]#: This method will fill out the DataAdaptor for a DCorrectorH linac accelerator node.

makeDA_dcorrV(seq_da, dcorr)[source]#: This method will fill out the DataAdaptor for a DCorrectorV linac accelerator node.

makeDA_marker(seq_da, marker)[source]#

makeDA_quad(seq_da, quad)[source]#: This method will fill out the DataAdaptor for a quad linac accelerator node.

makeDA_rf_gap(seq_da, rf_gap)[source]#: This method will fill out the DataAdaptor for a RF Gap linac accelerator node.

makeDAforAccSeq(acc_da, accSeq)[source]#: This method adds the accelerator sequence data to accelerator data adaptor.

makeDataAdaptorforLinacLattice(linacAccLattice)[source]#: This method generates and returns the accelerator data adaptor for the accelerator lattice.

setMaxDriftLength(maxDriftLength=1.0)[source]#: Sets the maximal drift length that is used for the purpose of the space charge calculations and diagnostics.