Module simpa.acc

Package simpa.acc.api

Class TwissParameters.Builder

java.lang.Object

simpa.acc.api.TwissParameters.Builder

Enclosing class:

TwissParameters

public static final class TwissParameters.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TwissParameters	build()
TwissParameters.Builder	copyOf(TwissParameters tp)	Copy the given Twiss parameters to this builder.
TwissParameters.Builder	dispH(double dispH)
TwissParameters.Builder	dispPrimeH(double dispPrimeH)
TwissParameters.Builder	dispPrimeV(double dispPrimeV)
TwissParameters.Builder	dispV(double dispV)
TwissParameters.Builder	dpOp(double dpOp)	Sets the relative momentum deviation from the reference momentum.
TwissParameters.Builder	hEllipse(PhaseSpaceEllipse hEllipse)
TwissParameters.Builder	longiPos(double lp)
TwissParameters.Builder	muH(double muH)
TwissParameters.Builder	muV(double muV)
TwissParameters.Builder	vEllipse(PhaseSpaceEllipse vEllipse)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

longiPos

public TwissParameters.Builder longiPos(double lp)

muH

public TwissParameters.Builder muH(double muH)

hEllipse

public TwissParameters.Builder hEllipse(PhaseSpaceEllipse hEllipse)

vEllipse

public TwissParameters.Builder vEllipse(PhaseSpaceEllipse vEllipse)

muV

public TwissParameters.Builder muV(double muV)

dispH

public TwissParameters.Builder dispH(double dispH)

dispV

public TwissParameters.Builder dispV(double dispV)

dispPrimeH

public TwissParameters.Builder dispPrimeH(double dispPrimeH)

dispPrimeV

public TwissParameters.Builder dispPrimeV(double dispPrimeV)

copyOf

public TwissParameters.Builder copyOf(TwissParameters tp)

Copy the given Twiss parameters to this builder.

Parameters:

tp - The Twiss parameters to be copied.

Returns:

The builder with the copied Twiss parameters.

dpOp

public TwissParameters.Builder dpOp(double dpOp)

Sets the relative momentum deviation from the reference momentum. This is used in the calculation of the beam size. It is not always needed, so it can be left not set.

Parameters:

dpOp - relative momentum deviation from the reference momentum.

Returns:

this

build

public TwissParameters build()