minimize_mismatch module

Hold mismatch related functions.

It has its own module as this quantity is pretty specific.

class MinimizeMismatch(*args, **kwargs)[source]

__init__(*args, **kwargs)[source]

Set complementary SimulationOutput.get() flags, reference value.

Parameters:

name – A short string to describe the objective and access to it.
weight – A scaling constant to set the weight of current objective.
get_key – Must contain ‘twiss’ plus the name of a phase-space, or simply ‘twiss’ and the phase-space is defined in get_kwargs.
get_kwargs – Keyword arguments for the SimulationOutput.get() method. We do not check its validity, but in general you will want to define the keys elt and pos. You should also define the phase_space_name key if it is not defined in the get_key.
reference – The reference simulation output from which the Twiss parameters will be taken.
descriptor – A longer string to explain the objective.