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

Class MatchingVariable

java.lang.Object
simpa.acc.api.match.MatchingVariable
public class MatchingVariable extends Object
Describes a variable to be matched or optimized, usually a scaling factor of a field map. When ititial conditions of a beam line are matched the maching variales are the Twiss parameters of the beam.

  • Constructor Details

    • MatchingVariable

      public MatchingVariable(MatchingVariableType matchingVariableType, String fieldMapName)
      Constructor for matching variables. If the matching variable is a field map scaling factor the field map name should be provided.
      Parameters:
      matchingVariableType - - The type of the matching variable
      fieldMapName - -The file name of a field map with extension ( FileNamingConventions.BIN_FILE_EXTENSION) The scaling factor for this field map will be sought during matching. It can be null if the matching variable is not a field map scaling factor.

  • Method Details

    • getMin

      public Double getMin()
      Returns:
      The minimum value for the scaling factor of the field map. This is usually the same as the minimum value of the power supply of the element, if the field map belongs to an element which has one.

    • setMin

      public void setMin(Double min)
      Parameters:
      min - Sets the minimum value for the scaling factor of the field map. This is usually the same as the minimum value of the power supply of the element, if the field map belongs to an element which has one.

    • getMax

      public Double getMax()
      Returns:
      The maximum value for the scaling factor of the field map. This is usually the same as the maximum value of the power supply of the element, if the field map belongs to an element which has one.

    • setMax

      public void setMax(Double max)
      Parameters:
      max - Sets the maximum value for the scaling factor of the field map. This is usually the same as the maximum value of the power supply of the element, if the field map belongs to an element which has one.

    • getInitialGuess

      public Double getInitialGuess()
      Returns:
      Initial guess for the variable

    • setInitialGuess

      public void setInitialGuess(Double initialGuess)
      Parameters:
      initialGuess - Sets the initial guess for the variable

    • getFieldMapName

      public String getFieldMapName()
      Returns:
      Name of the field map. When the MatchingVariableType is not SCALING_FACTOR this is the vale is null.

    • getValue

      public Double getValue()
      Returns:
      Value of the this matching variable. Called during matching and after.

    • setValue

      public void setValue(Double value)
      Parameters:
      value - sets the value of the this matching variable. Called during matching and after.

    • getMatchingVariableType

      public MatchingVariableType getMatchingVariableType()
      Returns:
      The type of the matching variable.