xal.extension.twissobserver

Enum PHASEPLANE

java.lang.Object

java.lang.Enum<PHASEPLANE>

xal.extension.twissobserver.PHASEPLANE

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PHASEPLANE>

public enum PHASEPLANE
extends java.lang.Enum<PHASEPLANE>

Enumeration of the mechanical motion phase planes for use in identifying the families of Courant-Snyder parameters. The enumeration also contains useful methods for converting between covariance space representations.

Since:

Jul 20, 2012

See Also:

PhaseMatrix, CorrelationMatrix

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOR Horizontal phase plane
LNG Longitudinal phase plane
VER Vertical phase plane

Method Summary

Modifier and Type	Method and Description
static CovarianceMatrix	constructCovariance(Jama.Matrix vecMmtsHor, Jama.Matrix vecMmtsVer, Jama.Matrix vecMmtsLng) Packs the second moments in the three vectors into a properly formatted covariance matrix.
double	extractBeamSize(Measurement msmt) Returns the beam size field corresponding to this phase plane from the given measurement data structure.
Jama.Matrix	extractCovarianceVector(CovarianceMatrix matCov) Extracts the (3) moments for the given phase plane from the covariance matrix and return them as a 3 × 1 vector.
CovarianceMatrix	getCovarianceBasis(int indBasis) Returns the covariance basis matrix for the given index.
int	getCovariantBasisSize() Returns the cardinality of the covariance basis set.
int	getCovIndexOffset() Returns the index offset into the covariance matrix for this phase plane.
PhaseMatrix	getStandardBasis(int indBasis) Returns the standard basis matrix for the given index.
int	getStandardBasisSize() Returns the cardinality of the standard basis set.
static PHASEPLANE	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PHASEPLANE[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HOR

public static final PHASEPLANE HOR

Horizontal phase plane

VER

public static final PHASEPLANE VER

Vertical phase plane

LNG

public static final PHASEPLANE LNG

Longitudinal phase plane

Method Detail

values

public static PHASEPLANE[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PHASEPLANE c : PHASEPLANE.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PHASEPLANE valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

constructCovariance

public static CovarianceMatrix constructCovariance(Jama.Matrix vecMmtsHor,
                                                   Jama.Matrix vecMmtsVer,
                                                   Jama.Matrix vecMmtsLng)

Packs the second moments in the three vectors into a properly formatted covariance matrix.

Parameters:

vecMmtsHor - vector of horizontal second moments

vecMmtsVer - vector of vertical second moments

vecMmtsLng - vector of longitudinal second moments

Returns:

the covariance matrix with the given moments as elements

Since:

Aug 31, 2012

getCovIndexOffset

public int getCovIndexOffset()

Returns the index offset into the covariance matrix for this phase plane. This is the diagonal index of the top left element of the 2×2 diagonal block that this enumeration constant represents.

Returns:

index offset identifying the block diagonal within the covariance matrix

Since:

Mar 27, 2013

getStandardBasisSize

public int getStandardBasisSize()

Returns the cardinality of the standard basis set.

Returns:

number of standard basis set matrices

Since:

Mar 28, 2013

getStandardBasis

public PhaseMatrix getStandardBasis(int indBasis)
                             throws java.lang.ArrayIndexOutOfBoundsException

Returns the standard basis matrix for the given index. There are four of these matrices for each phase plane. They provide an independent vector representation of the 4×4 diagonal block occupied by this phase space within phase matrices. Restricting to one block diagonal we have

e0	≡	| 1 0 |
		| 0 0 |

e1	≡	| 0 1 |
		| 0 0 |

e2	≡	| 0 0 |
		| 1 0 |

e3	≡	| 0 0 |
		| 0 1 |

The argument indBasis is the index i of e_i.

Parameters:

indBasis - The index of the basis vector

Returns:

The basis vector in covariance space as described above

Throws:

java.lang.ArrayIndexOutOfBoundsException - The given index is greater than 3

Since:

Mar 27, 2013

getCovariantBasisSize

public int getCovariantBasisSize()

Returns the cardinality of the covariance basis set.

Returns:

number of covariance basis set matrices

Since:

Mar 28, 2013

getCovarianceBasis

public CovarianceMatrix getCovarianceBasis(int indBasis)
                                    throws java.lang.ArrayIndexOutOfBoundsException

Returns the covariance basis matrix for the given index. There are three of these matrices for each phase plane. They provide a vector representation of the 4×4 block diagonal of the covariance matrix occupied by this phase plane. Because of the symmetry of the covariance matrix, there are only three independent basis vectors. Restricting attention to one block diagonal we have

c0	≡	| 1 0 |
		| 0 0 |

c1	≡	| 0 1 |
		| 1 0 |

c2	≡	| 0 0 |
		| 0 1 |

The argument indBasis is the index i of c_i.

Parameters:

indBasis - The index of the basis vector

Returns:

The basis vector in covariance space as described above

Throws:

java.lang.ArrayIndexOutOfBoundsException - The given index is greater than 3

Since:

Mar 27, 2013

extractBeamSize

public double extractBeamSize(Measurement msmt)

Returns the beam size field corresponding to this phase plane from the given measurement data structure.

Parameters:

msmt - data structure of beam size measurements for each phase plane

Returns:

the beam size measurement for this phase plane

Since:

Mar 28, 2013

extractCovarianceVector

public Jama.Matrix extractCovarianceVector(CovarianceMatrix matCov)

Extracts the (3) moments for the given phase plane from the covariance matrix and return them as a 3 × 1 vector. For example, for the horizontal plane we return (<x²>, <xx'>, <x'²>)^T.

Parameters:

matCov - the covariance matrix containing all the first and second order moments

Returns:

vector of moments for this phase plane

Since:

Mar 27, 2013