public class Illuminant
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.util.Date |
creationDate
The date this Illuminant was created.
|
protected java.lang.String |
creator
The user name of the creator of this Illuminant.
|
protected boolean |
isSourceOOI
Flag for whether this reference came from Ocean Optics, or from a user.
|
protected java.lang.String |
longDescription
The full name for the illuminant
|
protected java.lang.String |
shortDescription
The short description for the illuminant.
|
protected double[] |
values
The illuminant values for each wavelength.
|
protected double[] |
wavelengths
The wavelengths over which the illuminant is defined.
|
Constructor and Description |
---|
Illuminant()
Protected default constructor for use with XStream.
|
Illuminant(double[] wl,
double[] vals,
java.lang.String shortDescOrLocalizer,
java.lang.String longDescOrLocalizer)
Creates a new instance of Illuminant.
|
Modifier and Type | Method and Description |
---|---|
java.util.Date |
getCreationDate()
Gets the date this Illuminant was created.
|
java.lang.String |
getCreator()
Gets the user name of the creator of this Illuminant.
|
java.lang.String |
getLongDescription()
Gets the full name for the illuminant (such as Tungsten at 2856K,
Noon Sky Daylight, etc.)
|
java.lang.String |
getShortDescription()
Gets the short description for the illuminant (such as A, B, D50, F6,
etc).
|
double[] |
getValues()
Gets the illuminant values for each wavelength.
|
double[] |
getWavelengths()
Gets the wavelengths over which the illuminant is defined.
|
boolean |
isFromOOI()
If this returns true, when Ocean Optics, Inc. provided the values in
this file.
|
void |
setWavelengths(double[] newWl)
Sets the wavelengths over which the illuminant is defined.
|
java.lang.String |
toString()
Returns a string representation of the object.
|
protected double[] wavelengths
protected double[] values
protected java.lang.String shortDescription
protected java.lang.String longDescription
protected java.util.Date creationDate
protected java.lang.String creator
protected boolean isSourceOOI
public Illuminant()
public Illuminant(double[] wl, double[] vals, java.lang.String shortDescOrLocalizer, java.lang.String longDescOrLocalizer)
wl
- the wavelengths over which the illuminant is defined.vals
- the illuminant values for each wavelength.shortDescOrLocalizer
- the short description for the illuminant
(such as A, B, D50, F6, etc).longDescOrLocalizer
- the full name for the illuminant (such as
Tungsten at 2856K, Noon Sky Daylight, etc.)public java.lang.String getShortDescription()
public java.lang.String getLongDescription()
public double[] getWavelengths()
public void setWavelengths(double[] newWl)
newWl
- the new value to set the wavelengths over which the
illuminant is defined.public double[] getValues()
public java.lang.String getCreator()
public java.util.Date getCreationDate()
public boolean isFromOOI()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2004-2006 Ocean Optics, Inc. All Rights Reserved.