edu.nrao.sss.model.source
Enum BrightnessDistribution

java.lang.Object
  java.lang.Enum<BrightnessDistribution>
      edu.nrao.sss.model.source.BrightnessDistribution

All Implemented Interfaces:

Serializable, Comparable<BrightnessDistribution>

public enum BrightnessDistribution
extends Enum<BrightnessDistribution>

The distribution of the brightness of an astronomical source.

Version Info:

1.3

2006/05/22 16:23:44

dharland

Since:

2006-04-04

Author:

David M. Harland

Enum Constant Summary

CLEAN_COMPONENTS_FILE
A distribution described by a Clean Components file.

DISK
A disk-shaped distribution.

FITS_FILE
A distribution described by a Flexible Image Transport System file.

GAUSSIAN
A gaussian distribution.

POINT
A point distribution.

UNKNOWN
A brightness distribution of unknown type.

Method Summary

static BrightnessDistribution	fromString(String text) Returns the brightness distribution represented by text.
static BrightnessDistribution	getDefault() Returns a default brightness distribution.
String	toString() Returns a text representation of this enumeration constant.
static BrightnessDistribution	valueOf(String name) Returns the enum constant of this type with the specified name.
static BrightnessDistribution[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POINT

public static final BrightnessDistribution POINT

A point distribution.

GAUSSIAN

public static final BrightnessDistribution GAUSSIAN

A gaussian distribution.

DISK

public static final BrightnessDistribution DISK

A disk-shaped distribution.

FITS_FILE

public static final BrightnessDistribution FITS_FILE

A distribution described by a Flexible Image Transport System file.

CLEAN_COMPONENTS_FILE

public static final BrightnessDistribution CLEAN_COMPONENTS_FILE

A distribution described by a Clean Components file.

UNKNOWN

public static final BrightnessDistribution UNKNOWN

A brightness distribution of unknown type.

Method Detail

values

public static BrightnessDistribution[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BrightnessDistribution c : BrightnessDistribution.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BrightnessDistribution valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefault

public static BrightnessDistribution getDefault()

Returns a default brightness distribution.

Returns:

a default brightness distribution.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<BrightnessDistribution>

Returns:

a text representation of this enumeration constant.

fromString

public static BrightnessDistribution fromString(String text)

Returns the brightness distribution represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String).

Parameters:

text - a text representation of a brightness distribution.

Returns:

the brightness distribution represented by text.