objective package

We define the objects to parametrize the optimisation objectives.

Submodules

• factory module
  • ObjectiveFactory
    • ObjectiveFactory.objective_position_preset
    • ObjectiveFactory.compensation_zone_override_settings
    • ObjectiveFactory.__init__()
    • ObjectiveFactory._reference_simulation_output
    • ObjectiveFactory._reference_elts
    • ObjectiveFactory._failed_elements
    • ObjectiveFactory._objective_elements
    • ObjectiveFactory.get_objectives()
    • ObjectiveFactory._set_zone_to_recompute()
    • ObjectiveFactory.compute_residuals()
    • ObjectiveFactory._abc_impl
  • CorrectorAtExit
    • CorrectorAtExit.objective_position_preset
    • CorrectorAtExit.get_objectives()
    • CorrectorAtExit._preaccelerate()
    • CorrectorAtExit._preshape()
    • CorrectorAtExit._retrieve_energy()
    • CorrectorAtExit._abc_impl
  • EnergyMismatch
    • EnergyMismatch.objective_position_preset
    • EnergyMismatch.get_objectives()
    • EnergyMismatch._get_w_kin()
    • EnergyMismatch._get_mismatch()
    • EnergyMismatch._abc_impl
  • EnergyPhaseMismatch
    • EnergyPhaseMismatch.objective_position_preset
    • EnergyPhaseMismatch.get_objectives()
    • EnergyPhaseMismatch._get_w_kin()
    • EnergyPhaseMismatch._get_phi_abs()
    • EnergyPhaseMismatch._get_mismatch()
    • EnergyPhaseMismatch._abc_impl
  • EnergySyncPhaseMismatch
    • EnergySyncPhaseMismatch.objective_position_preset
    • EnergySyncPhaseMismatch.get_objectives()
    • EnergySyncPhaseMismatch._get_w_kin()
    • EnergySyncPhaseMismatch._get_phi_abs()
    • EnergySyncPhaseMismatch._get_mismatch()
    • EnergySyncPhaseMismatch._get_phi_s()
    • EnergySyncPhaseMismatch._abc_impl
  • EnergySeveralMismatches
    • EnergySeveralMismatches.objective_position_preset
    • EnergySeveralMismatches.get_objectives()
    • EnergySeveralMismatches._get_w_kin()
    • EnergySeveralMismatches._get_mismatch()
    • EnergySeveralMismatches._abc_impl
  • RegularEnvelope
    • RegularEnvelope.compensation_zone_override_settings
    • RegularEnvelope.__init__()
    • RegularEnvelope.get_objectives()
    • RegularEnvelope._get_std_twiss_beta()
    • RegularEnvelope._abc_impl
  • Spiral2
    • Spiral2._abc_impl
  • OBJECTIVE_PRESETS
  • PackedElements
    • PackedElements.broken_elts
    • PackedElements.failed_elements
    • PackedElements.compensating_elements
    • PackedElements.__init__()
  • ObjectiveMetaFactory
    • ObjectiveMetaFactory.__init__()
    • ObjectiveMetaFactory.create()
    • ObjectiveMetaFactory._factory_class()
• helper module
  • by_element()
• minimize_difference_with_ref module
  • MinimizeDifferenceWithRef
    • MinimizeDifferenceWithRef.__init__()
    • MinimizeDifferenceWithRef._abc_impl
• minimize_mismatch module
  • MinimizeMismatch
    • MinimizeMismatch.__init__()
    • MinimizeMismatch._abc_impl
• objective module
  • DEFAULT_ELT_KEY
  • Objective
    • Objective._gettable
    • Objective._advised_get_kwargs
    • Objective.__init__()
    • Objective.name
    • Objective.weight
    • Objective.ideal_value
    • Objective.residual
    • Objective.get_key
    • Objective.get_kwargs
    • Objective.__str__()
    • Objective.position_nature()
    • Objective._value_getter()
    • Objective._check_get_arguments()
    • Objective.str_header()
    • Objective.str_header_solved()
    • Objective._compute_residuals()
    • Objective.evaluate()
    • Objective._abc_impl
  • MinimizeDifferenceWithRef
    • MinimizeDifferenceWithRef.__init__()
    • MinimizeDifferenceWithRef._check_ideal_value()
    • MinimizeDifferenceWithRef._compute_residuals()
    • MinimizeDifferenceWithRef._abc_impl
  • MinimizeMismatch
    • MinimizeMismatch._gettable
    • MinimizeMismatch.__init__()
    • MinimizeMismatch._check_get_arguments()
    • MinimizeMismatch._twiss_getter()
    • MinimizeMismatch.evaluate()
    • MinimizeMismatch._compute_residuals()
    • MinimizeMismatch._abc_impl
  • MinimizeVariation
    • MinimizeVariation.__init__()
    • MinimizeVariation.__str__()
    • MinimizeVariation._check_get_arguments()
    • MinimizeVariation._compute_residuals()
    • MinimizeVariation._abc_impl
  • QuantityIsBetween
    • QuantityIsBetween.__init__()
    • QuantityIsBetween.relative_to_reference()
    • QuantityIsBetween.__str__()
    • QuantityIsBetween._compute_residuals()
    • QuantityIsBetween._abc_impl
  • RemainBelow
    • RemainBelow._advised_get_kwargs
    • RemainBelow.__init__()
    • RemainBelow.__str__()
    • RemainBelow._value_getter()
    • RemainBelow._compute_residuals()
    • RemainBelow._abc_impl
  • RetrieveArbitrary
    • RetrieveArbitrary.__init__()
    • RetrieveArbitrary._compute_residuals()
    • RetrieveArbitrary._abc_impl
  • str_objectives()
  • str_objectives_solved()
• position module
  • zone_to_recompute()
  • _zone()
  • _end_last_altered_lattice()
  • _one_lattice_after_last_altered_lattice()
  • _end_last_failed_lattice()
  • _one_lattice_after_last_failed_lattice()
  • _end_linac()
  • _reduce_idx_start_to_include_full_lattice()
  • _end_of_every_altered_lattice()
  • POSITION_TO_INDEX
• quantity_is_between module
  • QuantityIsBetween
    • QuantityIsBetween.__init__()
    • QuantityIsBetween._abc_impl