Class BandDefinition

Object

CodeList<BandDefinition>

BandDefinition

All Implemented Interfaces:

Serializable, Comparable<Band­Definition>

@UML(identifier="MI_BandDefinition",
     specification=ISO_19115_2)
public final class BandDefinition
extends CodeList<BandDefinition>

Designation of criterion for defining maximum and minimum wavelengths for a spectral band.

Since:

2.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

Code­List.Filter

Modifier and Type	Class	Description
static interface	Code­List.Filter	Used by Code­List.value­Of(Class, Filter) to select codes matching an arbitrary criterion.

Field Summary

Fields

Modifier and Type	Field	Description
static final Band­Definition	EQUIVALENT_WIDTH	Width of a band with full sensitivity or absorption at every wavelength that detects or absorbs the same amount of energy as the band described.
static final Band­Definition	FIFTY_PERCENT	Full spectral width of a spectral power density measured at 50% of its peak height.
static final Band­Definition	HALF_MAXIMUM	Width of a distribution equal to the distance between the outer two points on the distribution having power level half of that at the peak.
static final Band­Definition	ONE_OVER_E	Width of a distribution equal to the distance between the outer two points on the distribution having power level 1/e that of the peak.
static final Band­Definition	THREE_DB	Width of a distribution equal to the distance between the outer two points on the distribution having power level half of that at the peak.

Method Summary

Modifier and Type	Method	Description
Band­Definition[]	family()	Returns the list of enumerations of the same kind as this enum.
static Band­Definition	value­Of(String code)	Returns the band definition that matches the given string, or returns a new one if none match it.
static Band­Definition[]	values()	Returns the list of Band­Definitions.

Methods inherited from class CodeList

compare­To, identifier, name, names, ordinal, read­Resolve, to­String, value­Of, value­Of

Modifier and Type	Method	Description
final int	compare­To(Band­Definition other)	Compares this code with the specified object for order.
String	identifier()	Returns the identifier declared in the UML annotation, or null if none.
final String	name()	Returns the programmatic name of this code list constant.
String[]	names()	Returns all the names of this code.
final int	ordinal()	Returns the ordinal of this code constant.
protected Object	read­Resolve()	Resolves the code list to an unique instance after deserialization.
String	to­String()	Returns a string representation of this code list.
static <T extends Code­List<T>> T	value­Of(Class<T> code­Type, String name)	Returns the code of the given type that matches the given name, or returns a new one if none match it.
static <T extends Code­List<T>> T	value­Of(Class<T> code­Type, Code­List.Filter filter)	Returns the code of the given type that matches the given criterion, or returns a new one if none match it.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Field Details

THREE_DB

@UML(identifier="3dB",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final BandDefinition THREE_DB

Width of a distribution equal to the distance between the outer two points on the distribution having power level half of that at the peak.

"TODO:"

the same as the documentation for HALF_MAXIMUM.

HALF_MAXIMUM

@UML(identifier="halfMaximum",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final BandDefinition HALF_MAXIMUM

Width of a distribution equal to the distance between the outer two points on the distribution having power level half of that at the peak.

"TODO:"

the same as the documentation for THREE_DB.

FIFTY_PERCENT

@UML(identifier="fiftyPercent",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final BandDefinition FIFTY_PERCENT

Full spectral width of a spectral power density measured at 50% of its peak height.

ONE_OVER_E

@UML(identifier="oneOverE",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final BandDefinition ONE_OVER_E

Width of a distribution equal to the distance between the outer two points on the distribution having power level 1/e that of the peak.

EQUIVALENT_WIDTH

@UML(identifier="equivalentWidth",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final BandDefinition EQUIVALENT_WIDTH

Width of a band with full sensitivity or absorption at every wavelength that detects or absorbs the same amount of energy as the band described.

Method Details

values

public static BandDefinition[] values()

Returns the list of Band­Definitions.

Returns:

The list of codes declared in the current JVM.

family

public BandDefinition[] family()

Returns the list of enumerations of the same kind as this enum.

Specified by:

family in class Code­List<Band­Definition>

Returns:

The codes of the same kind as this code.

valueOf

public static BandDefinition valueOf(String code)

Returns the band definition that matches the given string, or returns a new one if none match it.

Parameters:

code - The name of the code to fetch or to create.

Returns:

A code matching the given name.