Module simpa.acc
Package simpa.acc.api.match

Enum Class MatchingTargetType

java.lang.Object
java.lang.Enum<MatchingTargetType>
simpa.acc.api.match.MatchingTargetType
All Implemented Interfaces:
Serializable, Comparable<MatchingTargetType>, Constable
public enum MatchingTargetType extends Enum<MatchingTargetType>
Enum listing the parameters that can be matched. It contains also the default weight for each parameter.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    H_ALPHA
    Horizontal alpha calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    H_ANGLE
    Horizontal angle [rad] of the fitted phase space ellipse center at a given longitudinal position in the sequence.
    H_BETA
    Horizontal beta calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    H_DISPERSION
    Horizontal dispersion [m] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    H_PHASE_ADVANCE
    Horizontal phase advance [rad] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    H_POSITION
    Horizontal position [m] of the fitted phase space ellipse center at a given longitudinal position in the sequence.
    H_SIGMA
    Horizontal sigma of the beam size [m] calculated at a given longitudinal position in the sequence.
    MAXIMUM_ABS_H_POSITION
    Maximum absolute value [m] of the horizontal dispersion in the sequence.
    MAXIMUM_ABS_V_POSITION
    Maximum absolute value [m] of the vertical dispersion in the sequence.
    MAXIMUM_H_BETA
    Horizontal maximum beta [m] in the sequence.
    MAXIMUM_H_DISPERSION
    Horizontal maximum dispersion [m] in the sequence.
    MAXIMUM_V_BETA
    Vertical maximum beta [m] in the sequence.
    MAXIMUM_V_DISPERSION
    Vertical maximum dispersion [m] in the sequence.
    MINIMUM_H_DISPERSION
    Horizontal minimum dispersion [m] in the sequence.
    MINIMUM_V_DISPERSION
    Vertical minimum dispersion [m] in the sequence.
    V_ALPHA
    Vertical alpha calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    V_ANGLE
    Vertical angle [rad] of the fitted phase space ellipse center at a given longitudinal position in the sequence.
    V_BETA
    Vertical beta calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    V_DISPERSION
    Vertical dispersion [m] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    V_PHASE_ADVANCE
    Vertical phase advance [rad] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.
    V_POSITION
    Vertical position [m] of the fitted phase space ellipse center at a given longitudinal position in the sequence.
    V_SIGMA
    Vertical sigma of the beam size [m] calculated at a given longitudinal position in the sequence.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getDefaultWeight()
     
    boolean
    isBeamParameter()
     
    boolean
    isGlobalParameter()
     
    static MatchingTargetType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MatchingTargetType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • H_POSITION

      public static final MatchingTargetType H_POSITION
      Horizontal position [m] of the fitted phase space ellipse center at a given longitudinal position in the sequence.

    • V_POSITION

      public static final MatchingTargetType V_POSITION
      Vertical position [m] of the fitted phase space ellipse center at a given longitudinal position in the sequence.

    • H_ANGLE

      public static final MatchingTargetType H_ANGLE
      Horizontal angle [rad] of the fitted phase space ellipse center at a given longitudinal position in the sequence.

    • V_ANGLE

      public static final MatchingTargetType V_ANGLE
      Vertical angle [rad] of the fitted phase space ellipse center at a given longitudinal position in the sequence.

    • H_ALPHA

      public static final MatchingTargetType H_ALPHA
      Horizontal alpha calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • V_ALPHA

      public static final MatchingTargetType V_ALPHA
      Vertical alpha calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • H_BETA

      public static final MatchingTargetType H_BETA
      Horizontal beta calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • V_BETA

      public static final MatchingTargetType V_BETA
      Vertical beta calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • H_PHASE_ADVANCE

      public static final MatchingTargetType H_PHASE_ADVANCE
      Horizontal phase advance [rad] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • V_PHASE_ADVANCE

      public static final MatchingTargetType V_PHASE_ADVANCE
      Vertical phase advance [rad] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • H_DISPERSION

      public static final MatchingTargetType H_DISPERSION
      Horizontal dispersion [m] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • V_DISPERSION

      public static final MatchingTargetType V_DISPERSION
      Vertical dispersion [m] calculated from the the fitted phase space ellipse at a given longitudinal position in the sequence.

    • H_SIGMA

      public static final MatchingTargetType H_SIGMA
      Horizontal sigma of the beam size [m] calculated at a given longitudinal position in the sequence.

    • V_SIGMA

      public static final MatchingTargetType V_SIGMA
      Vertical sigma of the beam size [m] calculated at a given longitudinal position in the sequence.

    • MAXIMUM_H_BETA

      public static final MatchingTargetType MAXIMUM_H_BETA
      Horizontal maximum beta [m] in the sequence.

    • MAXIMUM_V_BETA

      public static final MatchingTargetType MAXIMUM_V_BETA
      Vertical maximum beta [m] in the sequence.

    • MAXIMUM_H_DISPERSION

      public static final MatchingTargetType MAXIMUM_H_DISPERSION
      Horizontal maximum dispersion [m] in the sequence.

    • MAXIMUM_V_DISPERSION

      public static final MatchingTargetType MAXIMUM_V_DISPERSION
      Vertical maximum dispersion [m] in the sequence.

    • MINIMUM_H_DISPERSION

      public static final MatchingTargetType MINIMUM_H_DISPERSION
      Horizontal minimum dispersion [m] in the sequence. Useful when the dispersion is negative.

    • MINIMUM_V_DISPERSION

      public static final MatchingTargetType MINIMUM_V_DISPERSION
      Vertical minimum dispersion [m] in the sequence. Useful when the dispersion is negative.

    • MAXIMUM_ABS_H_POSITION

      public static final MatchingTargetType MAXIMUM_ABS_H_POSITION
      Maximum absolute value [m] of the horizontal dispersion in the sequence.

    • MAXIMUM_ABS_V_POSITION

      public static final MatchingTargetType MAXIMUM_ABS_V_POSITION
      Maximum absolute value [m] of the vertical dispersion in the sequence.

  • Method Details

    • values

      public static MatchingTargetType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MatchingTargetType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDefaultWeight

      public double getDefaultWeight()
      Returns:
      The default weight for this parameter

    • isGlobalParameter

      public boolean isGlobalParameter()
      Returns:
      True if the parameter is global for the sequence.

    • isBeamParameter

      public boolean isBeamParameter()
      Returns:
      True if the parameter is a result of an optics calculation. When this is true the parameter is calculated during the matching. Otherwise the tracking date will be processed otherwise for the matching.