Angle (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.spim.data.generic.base.Entity
- - mpicbg.spim.data.generic.base.NamedEntity
  - - mpicbg.spim.data.sequence.Angle

All Implemented Interfaces:

Comparable<Angle>
```
public class Angle
extends NamedEntity
implements Comparable<Angle>
```
Defines an angle which is part of the ViewSetup. An Angle is a NamedEntity that may have a rotation axis and angle.

Author:

Stephan Preibisch (stephan.preibisch@gmx.de), Tobias Pietzsch <tobias.pietzsch@gmail.com>

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Angle()`
	`Angle(int id)`
	`Angle(int id, String name)`
	`Angle(int id, String name, double rotationAngleDegrees, double[] rotationAxis)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Angle o)` Compares the `ids`.
`int`	`getId()` Get the unique id of this angle.
`String`	`getName()` Get the name of this angle.
`double`	`getRotationAngleDegrees()` Get the approximate rotation angle (as defined by the microscope meta-data).
`double[]`	`getRotationAxis()` Get the the approximate rotation axis (as defined by the microscope meta-data).
`boolean`	`hasRotation()` Is the approximate rotation defined?
`void`	`setName(String name)` Set the name of this angle.
`void`	`setRotation(double[] axis, double degrees)` Set the approximate rotation angle and axis (as defined by the microscope meta-data).

Methods inherited from class mpicbg.spim.data.generic.base.Entity
equals, hashCode, idMap, sortById

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

- Constructor Detail
  - Angle
```
public Angle(int id,
             String name,
             double rotationAngleDegrees,
             double[] rotationAxis)
```
  - Angle
```
public Angle(int id,
             String name)
```
  - Angle
```
public Angle(int id)
```
  - Angle
```
protected Angle()
```
- Method Detail
  - getId
```
public int getId()
```
    Get the unique id of this angle.
    
    Overrides:
    
    getId in class Entity
    
    Returns:
    
    unique id.
  - getName
```
public String getName()
```
    Get the name of this angle. The name is used for example to replace it in filenames when opening individual 3d-stacks (e.g. SPIM_TL20_Angle45.tif)
    
    Overrides:
    
    getName in class NamedEntity
  - setName
```
public void setName(String name)
```
    Set the name of this angle.
    
    Overrides:
    
    setName in class NamedEntity
  - hasRotation
```
public boolean hasRotation()
```
    Is the approximate rotation defined?
    
    Returns:
    
    true, if the approximate rotation is defined.
  - getRotationAxis
```
public double[] getRotationAxis()
```
    Get the the approximate rotation axis (as defined by the microscope meta-data).
    
    Returns:
    
    the rotation axis or null if rotation is undefined.
  - getRotationAngleDegrees
```
public double getRotationAngleDegrees()
```
    Get the approximate rotation angle (as defined by the microscope meta-data).
    
    Returns:
    
    the rotation angle in degrees or Double.NaN if rotation is undefined.
  - setRotation
```
public void setRotation(double[] axis,
                        double degrees)
```
    Set the approximate rotation angle and axis (as defined by the microscope meta-data).
    
    Parameters:
    
    axis -
    
    degrees -
  - compareTo
```
public int compareTo(Angle o)
```
    Compares the ids.
    
    Specified by:
    
    compareTo in interface Comparable<Angle>

Class Angle

Constructor Summary

Method Summary

Methods inherited from class mpicbg.spim.data.generic.base.Entity

Methods inherited from class java.lang.Object

Constructor Detail

Angle

Angle

Angle

Angle

Method Detail

getId

getName

setName

hasRotation

getRotationAxis

getRotationAngleDegrees

setRotation

compareTo