edu.nrao.sss.model.source
Class DescriptiveBrightness

java.lang.Object
  edu.nrao.sss.model.source.SourceBrightness
      edu.nrao.sss.model.source.DescriptiveBrightness

All Implemented Interfaces:

Identifiable, Cloneable, Comparable<SourceBrightness>

Direct Known Subclasses:

AreaBrightness, PointBrightness, UnknownBrightness

public abstract class DescriptiveBrightness
extends SourceBrightness

A base class for all source brightnesses that are not file based.

Version Info:

$Revision: 913 $

$Date: 2007-09-25 08:55:39 -0600 (Tue, 25 Sep 2007) $

$Author: dharland $

Since:

2006-05-16

Author:

David M. Harland

Field Summary

Fields inherited from interface edu.nrao.sss.util.Identifiable

UNIDENTIFIED

Method Summary

FluxDensity	getPeakFluxDensity() Returns the peak flux density of this source brightness.
StokesParameter	getPolarization() Returns the polarization of this source brightness.
FluxDensity	getTotalFluxDensity() Returns the total flux density of this source brightness.
FrequencyRange	getValidFrequency() Returns the frequency range for which this source brightness is valid.
void	setPeakFluxDensity(FluxDensity newDensity) Sets the peak flux density of this brightness.
void	setPolarization(StokesParameter newPolarization) Sets the polarization for this brightness.
void	setTotalFluxDensity(FluxDensity newDensity) Sets the total flux density of this brightness.
void	setValidFrequency(FrequencyRange newRange) Sets the valid frequency range for this source brightness.

Methods inherited from class edu.nrao.sss.model.source.SourceBrightness

clone, compareTo, createBrightness, createBrightnesses, equals, getBrightnessFile, getDistributionType, getId, getLimbDarkening, getMajorAxisDiameter, getMinorAxisDiameter, getObservation, getPositionAngle, getValidTime, getVlaObservation, hashCode, isFileBased, isValidFor, reset, setValidTime

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

setPolarization

public void setPolarization(StokesParameter newPolarization)

Sets the polarization for this brightness.

If newPolarization is null, this brightness's polarization will be set to a default value.

Parameters:

newPolarization - the polarization for this source brightness.

setValidFrequency

public void setValidFrequency(FrequencyRange newRange)

Sets the valid frequency range for this source brightness.

If newRange is null, this brightness's frequency range will be set to all (positive) frequencies.

Note that this brightness will hold a reference to newRange (unless it is null). This means that any changes to newRange by other objects after this call is made will be reflected in this brightness.

Parameters:

newRange - the frequency range for this source brightness.

setPeakFluxDensity

public void setPeakFluxDensity(FluxDensity newDensity)

Sets the peak flux density of this brightness.

If newDensity is null, this brightness's peak flux density will be set zero janskies.

Note that this brightness will hold a reference to newDensity (unless it is null). This means that any changes to newDensity by other objects after this call is made will be reflected in this brightness.

Parameters:

newDensity - the new peak flux density for this source brightness.

setTotalFluxDensity

public void setTotalFluxDensity(FluxDensity newDensity)

Sets the total flux density of this brightness.

If newDensity is null, this brightness's total flux density will be set zero janskies.

Note that this brightness will hold a reference to newDensity (unless it is null). This means that any changes to newDensity by other objects after this call is made will be reflected in this brightness.

Parameters:

newDensity - the new total flux density for this source brightness.

getPolarization

public StokesParameter getPolarization()

Description copied from class: SourceBrightness

Returns the polarization of this source brightness.

Overrides:

getPolarization in class SourceBrightness

Returns:

the polarization of this source brightness.

getValidFrequency

public FrequencyRange getValidFrequency()

Description copied from class: SourceBrightness

Returns the frequency range for which this source brightness is valid.

The return value is guaranteed to be non-null. It is also the range that is held internally by this source brightness, so any changes made to the returned range will be reflected in this object.

Overrides:

getValidFrequency in class SourceBrightness

Returns:

the valid frequency range for this source velocity.

getPeakFluxDensity

public FluxDensity getPeakFluxDensity()

Description copied from class: SourceBrightness

Returns the peak flux density of this source brightness.

The returned value is guaranteed to be non-null. It is also the peak flux density that is held internally by this source brightness, so any changes made to the returned flux density will be reflected in this object.

Overrides:

getPeakFluxDensity in class SourceBrightness

Returns:

the peak flux density of this source brightness.

getTotalFluxDensity

public FluxDensity getTotalFluxDensity()

Description copied from class: SourceBrightness

Returns the total flux density of this source brightness.

The returned value is guaranteed to be non-null. It is also the total flux density that is held internally by this source brightness, so any changes made to the returned flux density will be reflected in this object.

Overrides:

getTotalFluxDensity in class SourceBrightness

Returns:

the total flux density of this source brightness.