edu.nrao.sss.model.resource.vla
Enum BandwidthCode

java.lang.Object
  java.lang.Enum<BandwidthCode>
      edu.nrao.sss.model.resource.vla.BandwidthCode

All Implemented Interfaces:

Serializable, Comparable<BandwidthCode>

public enum BandwidthCode
extends Enum<BandwidthCode>

Enum Constant Summary

EIGHT

FIVE

FOUR

NINE

ONE

SEVEN

SIX

THREE

TWO

ZERO

Method Summary

Frequency	getBandwidthForContinuum() Returns the bandwidth associated with this code in continuum mode.
Frequency	getBandwidthForSpectralLine() Returns the bandwidth associated with this code in spectral line mode.
Frequency	getBandwidthForSpectralLine(IFMode ifMode, Set<ProcessingType> spectralLineProcessing) Returns the bandwidth for this code and the given IF mode and processing options.
Frequency	getBandwidthNominal()
int	getChannels(IFMode ifMode) Returns the maximum number of spectral channels that can be created using this band code and the given IF mode.
int	getChannels(IFMode ifMode, Set<ProcessingType> spectralLineProcessing) Returns the maximum number of spectral channels that can be created using this band code and the given IF mode and processing options.
int	getCodeNumber() Returns an integer representation of this band code.
static List<BandwidthCode>	getContinuumCodes() Returns the subset of codes that may be used for continuum observations.
int	getLags(IFMode ifMode) Returns the number of lags associated with this bandwith code and IF mode.
Frequency	getResolution(IFMode ifMode) Returns the best spectral resolution that can be obtained using this band code and the given IF mode.
Frequency	getResolution(IFMode ifMode, Set<ProcessingType> spectralLineProcessing) Returns the best spectral resolution that can be obtained using this band code and the given IF mode and processing options.
static List<BandwidthCode>	getSpectralLineCodes() Returns the subset of codes that may be used for spectral line observations.
TimeDuration	getTimeResolution(IFMode ifMode, Set<ProcessingType> spectralLineProcessing) Returns the time resolution that can be obtained using this band code and the given IF mode and processing options.
boolean	isValidForContinuum() Returns true if this bandwidth code is valid for continuum observations.
boolean	isValidForSpectralLine() Returns true if this bandwidth code is valid for spectral line observations.
static BandwidthCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BandwidthCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ZERO

public static final BandwidthCode ZERO

ONE

public static final BandwidthCode ONE

TWO

public static final BandwidthCode TWO

THREE

public static final BandwidthCode THREE

FOUR

public static final BandwidthCode FOUR

FIVE

public static final BandwidthCode FIVE

SIX

public static final BandwidthCode SIX

SEVEN

public static final BandwidthCode SEVEN

EIGHT

public static final BandwidthCode EIGHT

NINE

public static final BandwidthCode NINE

Method Detail

values

public static BandwidthCode[] 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 (BandwidthCode c : BandwidthCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BandwidthCode 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

getContinuumCodes

public static List<BandwidthCode> getContinuumCodes()

Returns the subset of codes that may be used for continuum observations.

Returns:

the subset of codes that may be used for continuum observations.

getSpectralLineCodes

public static List<BandwidthCode> getSpectralLineCodes()

Returns the subset of codes that may be used for spectral line observations.

Returns:

the subset of codes that may be used for spectral line observations.

getCodeNumber

public int getCodeNumber()

Returns an integer representation of this band code.

Returns:

an integer representation of this band code.

isValidForContinuum

public boolean isValidForContinuum()

Returns true if this bandwidth code is valid for continuum observations.

Returns:

true if this bandwidth code is valid for continuum observations.

isValidForSpectralLine

public boolean isValidForSpectralLine()

Returns true if this bandwidth code is valid for spectral line observations.

Returns:

true if this bandwidth code is valid for spectral line observations.

getBandwidthNominal

public Frequency getBandwidthNominal()

getBandwidthForContinuum

public Frequency getBandwidthForContinuum()

Returns the bandwidth associated with this code in continuum mode.

Returns:

the bandwidth associated with this code in continuum mode.

getBandwidthForSpectralLine

public Frequency getBandwidthForSpectralLine(IFMode ifMode,
                                             Set<ProcessingType> spectralLineProcessing)

Returns the bandwidth for this code and the given IF mode and processing options.

Parameters:

ifMode - the IF mode for which the bandwidth is desired. Normally the IF mode does not influence bandwidth, and this parameter may be null. However, when channel-zero processing is requested, we need to know the width of a single channel, and the IF mode is required for that. (See getResolution(IFMode, Set).)

spectralLineProcessing - a list of the spectral line processing options that will be used. This parameter may be null.

Returns:

the bandwidth for this code and the given IF mode and processing options.

getChannels

public int getChannels(IFMode ifMode,
                       Set<ProcessingType> spectralLineProcessing)

Returns the maximum number of spectral channels that can be created using this band code and the given IF mode and processing options.

Parameters:

ifMode - the IF mode for which the number of channels is desired.

spectralLineProcessing - a list of the spectral line processing options that will be used. This parameter may be null.

Returns:

the maximum number of channels for the given IF mode and processing options.

getResolution

public Frequency getResolution(IFMode ifMode,
                               Set<ProcessingType> spectralLineProcessing)

Returns the best spectral resolution that can be obtained using this band code and the given IF mode and processing options.

Parameters:

ifMode - the IF mode for which the resolution is desired.

spectralLineProcessing - a list of the spectral line processing options that will be used. This parameter may be null.

Returns:

the best spectral resolution for the given parameters.

getTimeResolution

public TimeDuration getTimeResolution(IFMode ifMode,
                                      Set<ProcessingType> spectralLineProcessing)

Returns the time resolution that can be obtained using this band code and the given IF mode and processing options. If this is the continuum bandwidth code, the returned resolution will be zero.

Parameters:

ifMode - the IF mode for which the resolution is desired.

spectralLineProcessing - a list of the spectral line processing options that will be used. This parameter may be null.

Returns:

the best time resolution for the given parameters.

getBandwidthForSpectralLine

public Frequency getBandwidthForSpectralLine()

Returns the bandwidth associated with this code in spectral line mode.

Returns:

the bandwidth associated with this code in spectral line mode.

getChannels

public int getChannels(IFMode ifMode)

Returns the maximum number of spectral channels that can be created using this band code and the given IF mode.

Parameters:

ifMode - the IF mode for which the number of channels is desired.

Returns:

the maximum number of channels for the given IF mode.

getResolution

public Frequency getResolution(IFMode ifMode)

Returns the best spectral resolution that can be obtained using this band code and the given IF mode.

Parameters:

ifMode - the IF mode for which the resolution is desired.

Returns:

the best spectral resolution for the given IF mode.

getLags

public int getLags(IFMode ifMode)

Returns the number of lags associated with this bandwith code and IF mode. The results from this method make sense only for the ProcessingType.LAG spectral line processing option.

Parameters:

ifMode - the IF mode for which the number of lags is desired.

Returns:

the number of lags associated with this bandwith code and IF mode.