edu.nrao.sss.model.project.scan
Class ScanDopplerSpecs

java.lang.Object
  edu.nrao.sss.model.project.scan.ScanDopplerSpecs

All Implemented Interfaces:

Cloneable

public class ScanDopplerSpecs
extends Object
implements Cloneable

A grouping of a sky position, radial velocity, and rest frame for specifying Doppler tracking information for a scan.

Version Info:

$Revision: 2102 $

$Date: 2009-03-12 08:49:53 -0600 (Thu, 12 Mar 2009) $

$Author: dharland $ (last person to modify)

Since:

2008-09-10

Author:

David M. Harland

Constructor Summary

ScanDopplerSpecs()
Creates a new specification with a null position and velocity.

ScanDopplerSpecs(SkyPosition sourcePosition, LinearVelocity sourceVelocity, VelocityFrame restFrame, VelocityConvention velocityConvention)
Creates a new specification with the given properties.

Method Summary

ScanDopplerSpecs	clone()
boolean	equals(Object o)
SkyPosition	getPosition() The sky position to use for Doppler tracking.
VelocityFrame	getRestFrame() The rest frame to use for the Doppler tracking velocity.
LinearVelocity	getVelocity() The source velocity to use for Doppler tracking.
VelocityConvention	getVelocityConvention() The velocity convention to use for the Doppler tracking velocity.
int	hashCode()
void	setPosition(SkyPosition newPosition) Sets the sky position to use when Doppler tracking.
void	setVelocity(LinearVelocity newVelocity, VelocityFrame newFrame, VelocityConvention newConvention) Sets the source velocity to use when Doppler tracking.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanDopplerSpecs

public ScanDopplerSpecs()

Creates a new specification with a null position and velocity.

ScanDopplerSpecs

public ScanDopplerSpecs(SkyPosition sourcePosition,
                        LinearVelocity sourceVelocity,
                        VelocityFrame restFrame,
                        VelocityConvention velocityConvention)

Creates a new specification with the given properties.

Parameters:

sourcePosition - See setPosition(SkyPosition).

sourceVelocity - See setVelocity(LinearVelocity, VelocityFrame, VelocityConvention).

restFrame - See setVelocity(LinearVelocity, VelocityFrame, VelocityConvention).

velocityConvention - See setVelocity(LinearVelocity, VelocityFrame, VelocityConvention).

Method Detail

setPosition

public final void setPosition(SkyPosition newPosition)

Sets the sky position to use when Doppler tracking.

Parameters:

newPosition - a position to use for Doppler tracking calculations. A value of null may be used as a signal to the scan to use the position of its source.

setVelocity

public final void setVelocity(LinearVelocity newVelocity,
                              VelocityFrame newFrame,
                              VelocityConvention newConvention)

Sets the source velocity to use when Doppler tracking.

Parameters:

newVelocity - a source velocity to use for Doppler tracking calculations. Note that this is only the radial velocity of a source relative to a frame of rest. It does not account for the motion of Earth. A value of null may be used as a signal to the scan to use the velocity of its source.

newFrame - the rest frame against which newVelocity is measured.

newConvention - the convention used to determine newVelocity.

Throws:

IllegalArgumentException - if exactly one of the parameters is null.

getPosition

public SkyPosition getPosition()

The sky position to use for Doppler tracking. The returned value may be null, which the scan will take as a signal to use the position of its source.

Returns:

the sky position to use for Doppler tracking.

getVelocity

public LinearVelocity getVelocity()

The source velocity to use for Doppler tracking. The returned value may be null, which the scan will take as a signal to use the velocity of its source.

Note that the returned velocity is only that of the source with respect to its rest frame. It does not include the motion of Earth.

If the returned value is null, the returned value of getRestFrame() and getVelocityConvention() will also be null.

Returns:

the source velocity to use for Doppler tracking.

getVelocityConvention

public VelocityConvention getVelocityConvention()

The velocity convention to use for the Doppler tracking velocity. The returned value may be null, which the scan will take as a signal to use the convention of its source's velocity.

If the returned value is null, the returned value of getVelocity() and getRestFrame() will also be null.

Returns:

the velocity convention to use for Doppler tracking.

getRestFrame

public VelocityFrame getRestFrame()

The rest frame to use for the Doppler tracking velocity. The returned value may be null, which the scan will take as a signal to use the frame of its source's velocity.

If the returned value is null, the returned value of getVelocity() and getVelocityConvention() will also be null.

Returns:

the rest frame to use for the Doppler tracking velocity.

clone

public ScanDopplerSpecs clone()

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object