Twiss3D

java.lang.Object
- xal.tools.beam.Twiss3D

All Implemented Interfaces:: IArchive

public class Twiss3D
extends java.lang.Object
implements IArchive

Class .

Since:: Nov 5, 2013

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Twiss3D.IND_3D
Enumeration for the element position indices of three-dimensional objects.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Twiss3D.IND_3D` Enumeration for the element position indices of three-dimensional objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`ATTR_ALPHA_X` attribute tags for Twiss parameters
`protected static java.lang.String`	`ATTR_ALPHA_Y`
`protected static java.lang.String`	`ATTR_ALPHA_Z`
`protected static java.lang.String`	`ATTR_BETA_X`
`protected static java.lang.String`	`ATTR_BETA_Y`
`protected static java.lang.String`	`ATTR_BETA_Z`
`protected static java.lang.String`	`ATTR_EMIT_X`
`protected static java.lang.String`	`ATTR_EMIT_Y`
`protected static java.lang.String`	`ATTR_EMIT_Z`
`protected static java.lang.String`	`LABEL_TWISS` element tag for envelope twiss parameters

Constructor Summary

Constructors
Constructor and Description
`Twiss3D()` Create a new, empty
`Twiss3D(DataAdaptor daSource)` Initializing Constructor: Create a new `Twiss3D` object and initialize it with data from the data source behind the `DataAdaptor` interface.
`Twiss3D(Twiss[] arrTwiss)` Initializing constructor for `Twiss3D`.
`Twiss3D(Twiss3D t3d)` Copy Constructor.
`Twiss3D(Twiss twissX, Twiss twissY, Twiss twissZ)` Initializing Constructor: Create a new `Twiss3D` object and initialize to the given argument values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Twiss3D`	`copy()` Creates a new, cloned instance of this `Twiss3D`.
`Twiss[]`	`getTwiss()` Returns the array of Twiss parameters for this distribution for all three planes.
`Twiss`	`getTwiss(Twiss3D.IND_3D iPlane)` Returns the Twiss parameters for the given phase plane.
`void`	`load(DataAdaptor daSource)` Recover the state values particular to `BunchDistribution` objects from the data source.
`double[]`	`rmsEmittances()` Convenience Method: Returns the rms emittances for this distribution as from the individual Twiss parameters.
`void`	`save(DataAdaptor daSink)` Save the state of this object to the data sink behind the `DataAdaptor` interface.
`void`	`setTwiss(Twiss3D.IND_3D iPlane, Twiss twiss)` Set the Twiss parameters for the given phase plane.
`java.lang.String`	`toString()` Returns a textual representation of the internal state of this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LABEL_TWISS
```
protected static final java.lang.String LABEL_TWISS
```
    element tag for envelope twiss parameters
    
    See Also:
    
    Constant Field Values
  - ATTR_ALPHA_X
```
protected static final java.lang.String ATTR_ALPHA_X
```
    attribute tags for Twiss parameters
    
    See Also:
    
    Constant Field Values
  - ATTR_BETA_X
```
protected static final java.lang.String ATTR_BETA_X
```
    See Also:
    
    Constant Field Values
  - ATTR_EMIT_X
```
protected static final java.lang.String ATTR_EMIT_X
```
    See Also:
    
    Constant Field Values
  - ATTR_ALPHA_Y
```
protected static final java.lang.String ATTR_ALPHA_Y
```
    See Also:
    
    Constant Field Values
  - ATTR_BETA_Y
```
protected static final java.lang.String ATTR_BETA_Y
```
    See Also:
    
    Constant Field Values
  - ATTR_EMIT_Y
```
protected static final java.lang.String ATTR_EMIT_Y
```
    See Also:
    
    Constant Field Values
  - ATTR_ALPHA_Z
```
protected static final java.lang.String ATTR_ALPHA_Z
```
    See Also:
    
    Constant Field Values
  - ATTR_BETA_Z
```
protected static final java.lang.String ATTR_BETA_Z
```
    See Also:
    
    Constant Field Values
  - ATTR_EMIT_Z
```
protected static final java.lang.String ATTR_EMIT_Z
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Twiss3D
```
public Twiss3D()
```
    Create a new, empty
  - Twiss3D
```
public Twiss3D(Twiss3D t3d)
```
    Copy Constructor. Create a new Twiss3D object which is a deep copy of the given argument.
    
    Parameters:
    
    t3d - Twiss3D containing initializing state information
  - Twiss3D
```
public Twiss3D(Twiss[] arrTwiss)
```
    Initializing constructor for Twiss3D.
    
    Parameters:
    
    arrTwiss - array of Twiss parameter for each phase plane
    
    Since:
    
    Nov 5, 2013
  - Twiss3D
```
public Twiss3D(Twiss twissX,
               Twiss twissY,
               Twiss twissZ)
```
    Initializing Constructor: Create a new Twiss3D object and initialize to the given argument values.
    
    Parameters:
    
    twissX - x-plane Twiss parameters
    
    twissY - y-plane Twiss parameters
    
    twissZ - z-plane Twiss parameters
  - Twiss3D
```
public Twiss3D(DataAdaptor daSource)
        throws DataFormatException
```
    Initializing Constructor: Create a new Twiss3D object and initialize it with data from the data source behind the DataAdaptor interface.
    
    Parameters:
    
    daSource - data source containing initializing data
    
    Throws:
    
    DataFormatException - parsing error of data source
- Method Detail
  - copy
```
public Twiss3D copy()
```
    Creates a new, cloned instance of this Twiss3D.
    
    Returns:
    
    a clone of this Twiss3D
    
    Since:
    
    Jul 9, 2014
  - setTwiss
```
public void setTwiss(Twiss3D.IND_3D iPlane,
                     Twiss twiss)
```
    Set the Twiss parameters for the given phase plane.
    
    Parameters:
    
    iPlane - phase plane index
    
    twiss - twiss parameters
  - getTwiss
```
public Twiss getTwiss(Twiss3D.IND_3D iPlane)
```
    Returns the Twiss parameters for the given phase plane.
    
    Parameters:
    
    iPlane - phase plane index
    
    Returns:
    
    twiss parameters for given phase plane
  - getTwiss
```
public Twiss[] getTwiss()
```
    Returns the array of Twiss parameters for this distribution for all three planes.
    
    Returns:
    
    array(twiss-H, twiss-V, twiss-L)
  - rmsEmittances
```
public double[] rmsEmittances()
```
    Convenience Method: Returns the rms emittances for this distribution as from the individual Twiss parameters.
    
    Returns:
    
    array (ex,ey,ez) of rms emittances
  - save
```
public void save(DataAdaptor daSink)
```
    Save the state of this object to the data sink behind the DataAdaptor interface.
    
    Specified by:
    
    save in interface IArchive
    
    Parameters:
    
    daSink - data sink represented by DataAdaptor interface
    
    See Also:
    
    IArchive.save(xal.tools.data.DataAdaptor)
  - load
```
public void load(DataAdaptor daSource)
          throws DataFormatException
```
    Recover the state values particular to BunchDistribution objects from the data source.
    
    Specified by:
    
    load in interface IArchive
    
    Parameters:
    
    daSource - data source represented by a DataAdaptor interface
    
    Throws:
    
    DataFormatException - state information in data source is malformatted
    
    See Also:
    
    IArchive.load(xal.tools.data.DataAdaptor)
  - toString
```
public java.lang.String toString()
```
    Returns a textual representation of the internal state of this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representation of this object's value
    
    Since:
    
    Nov 22, 2013
    
    See Also:
    
    Object.toString()

Class Twiss3D

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LABEL_TWISS

ATTR_ALPHA_X

ATTR_BETA_X

ATTR_EMIT_X

ATTR_ALPHA_Y

ATTR_BETA_Y

ATTR_EMIT_Y

ATTR_ALPHA_Z

ATTR_BETA_Z

ATTR_EMIT_Z

Constructor Detail

Twiss3D

Twiss3D

Twiss3D

Twiss3D

Twiss3D

Method Detail

copy

setTwiss

getTwiss

getTwiss

rmsEmittances

save

load

toString