Illumination (Fiji Javadocs 0-SNAPSHOT API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

Comparable<Illumination>
```
public class Illumination
extends NamedEntity
implements Comparable<Illumination>
```
Defines an illumination direction which is part of the ViewSetup.

Author:

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Illumination()`
	`Illumination(int id)` Construct an illumination direction with the specified id.
	`Illumination(int id, String name)` Construct an illumination direction with the specified id and name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Illumination o)` Compares the `ids`.
`int`	`getId()` Get the unique id of this illumination direction.
`String`	`getName()` Get the name of this illumination direction.
`void`	`setName(String name)` Set the name of this illumination direction.

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
  - Illumination
```
public Illumination(int id,
                    String name)
```
    Construct an illumination direction with the specified id and name.
    
    Parameters:
    
    id -
    
    name -
  - Illumination
```
public Illumination(int id)
```
    Construct an illumination direction with the specified id. The name is set to the String representation of the id.
    
    Parameters:
    
    id -
  - Illumination
```
protected Illumination()
```
- Method Detail
  - getId
```
public int getId()
```
    Get the unique id of this illumination direction.
    
    Overrides:
    
    getId in class Entity
    
    Returns:
    
    unique id.
  - getName
```
public String getName()
```
    Get the name of this illumination direction. The name is used for example to replace it in filenames when opening individual 3d-stacks (e.g. SPIM_TL20_Angle45_Illumination5.tif or SPIM_TL5_GFP.czi)
    
    Overrides:
    
    getName in class NamedEntity
  - setName
```
public void setName(String name)
```
    Set the name of this illumination direction.
    
    Overrides:
    
    setName in class NamedEntity
  - compareTo
```
public int compareTo(Illumination o)
```
    Compares the ids.
    
    Specified by:
    
    compareTo in interface Comparable<Illumination>

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2021 Fiji. All rights reserved.