stella.parameter
Class DiurnalVelocity

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.parameter.AbstractParameter
                  stella.parameter.AbstractTargetParameter
                      stella.parameter.AbstractTargetValue
                          stella.parameter.DiurnalVelocity

All Implemented Interfaces:

Cloneable, Parameter, TargetDependingValue, ParameterDepending, TargetDepending, TargetDependingParameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class DiurnalVelocity
extends AbstractTargetValue
implements ParameterDepending, Reloadable

Parameter that calculates the part of the radial velocity correction that is due to Earth's rotation. The formulars are from IRAF's rvcorrect. Overall accuaracy stated is 5m/s, thus only applicable for quick-look reduction.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

private TargetDependingParameter	de The declination of the target.
private static String	DEFALTITUDE The name of the altitude.
private static String	DEFDEC The name of the declination of the target to use.
private static String	DEFLATITUDE The name of the latitude parameter.
static String	DEFNAME The name of this parameter.
private static String	DEFTAU The name of the tau target to use.
private Value	h The altitude.
static String	KEY_ALTITUDE The name of the altitude.
static String	KEY_DEC The name of the declination of the target to use.
static String	KEY_LATITUDE The name of the latitude parameter.
static String	KEY_TAU The name of the tau target to use.
private Value	phi The latitude.
private TargetDependingParameter	tau The hour angle of the target.

Fields inherited from class stella.parameter.AbstractTargetParameter

KEY_INDEX

Fields inherited from class stella.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyBundles

KEY_LOCALECOUNTRY, KEY_LOCALELANGUAGE, KEY_RESOURCEBUNDLES

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, localurl, locate, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_URL, urlset

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

DiurnalVelocity(Map info)
Constructs a new tau target object.

Method Summary

private Double	calculate(double tdeg, double ddeg) Calculates the amount of the diurnal velocitry contribution to the barycentric velocity.
Number	getForTarget(TargetDefinition star) Gets the declination of the target star.
Number	getValue() Returns the actual target's hour angle in degrees, wrapped into a Double.
void	registerParameter(Parameter what) Registers the required additional globals for the tau target.
void	registerTarget(TargetDefinition star) Registers a star to this parameter.
double	rescanned(String key, String old, String newval) As any parameter depending instance we fail if the parameter we depend on is now a different one.
Number	setValue(Number val) Sets the hour angle of the actual target.

Methods inherited from class stella.parameter.AbstractTargetValue

get, set

Methods inherited from class stella.parameter.AbstractTargetParameter

getAsStar, getConstant, getFormattedFor, getSetup

Methods inherited from class stella.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, init, register, setName, toString

Methods inherited from class util.PropertyBundles

clone, getLocalized, getLocalized, getLocalizedString, getLocalizedString, loadResource

Methods inherited from class util.PropertyResources

createFrom, createFrom, createFrom, getApplet, getAsResources, getLocalClassLoader, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, reload, removeProperty, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.Reloadable

reload

Methods inherited from interface stella.TargetDependingParameter

getFormattedFor

Methods inherited from interface stella.Parameter

getFormatted, getName, getString

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface util.Initializable

init

Methods inherited from interface util.ResourceSupplying

getResource, getResourceAsStream, getResources

Field Detail

KEY_TAU

public static final String KEY_TAU

The name of the tau target to use.

See Also:

Constant Field Values

KEY_DEC

public static final String KEY_DEC

The name of the declination of the target to use.

See Also:

Constant Field Values

KEY_LATITUDE

public static final String KEY_LATITUDE

The name of the latitude parameter.

See Also:

Constant Field Values

KEY_ALTITUDE

public static final String KEY_ALTITUDE

The name of the altitude.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The name of this parameter.

See Also:

Constant Field Values

DEFTAU

private static final String DEFTAU

The name of the tau target to use.

See Also:

Constant Field Values

DEFDEC

private static final String DEFDEC

The name of the declination of the target to use.

See Also:

Constant Field Values

DEFLATITUDE

private static final String DEFLATITUDE

The name of the latitude parameter.

See Also:

Constant Field Values

DEFALTITUDE

private static final String DEFALTITUDE

The name of the altitude.

See Also:

Constant Field Values

phi

private Value phi

The latitude.

h

private Value h

The altitude.

de

private TargetDependingParameter de

The declination of the target.

tau

private TargetDependingParameter tau

The hour angle of the target.

Constructor Detail

DiurnalVelocity

public DiurnalVelocity(Map info)

Constructs a new tau target object. Note that this global can only function correctly after the sidereal time and ra target have been registered.

Method Detail

rescanned

public double rescanned(String key,
                        String old,
                        String newval)

As any parameter depending instance we fail if the parameter we depend on is now a different one.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class AbstractParameter

setValue

public Number setValue(Number val)
                throws UnsupportedOperationException

Sets the hour angle of the actual target. This is a read-only variable, therefore this method throws an UnsupportedOperationException.

Specified by:

setValue in interface Value

Throws:

UnsupportedOperationException

registerTarget

public void registerTarget(TargetDefinition star)

Registers a star to this parameter. The target definition is directly passed to the #ra reference of this parameter. Note that this will set the target in the additional parameter, too.

Specified by:

registerTarget in interface TargetDepending

getForTarget

public Number getForTarget(TargetDefinition star)

Gets the declination of the target star.

Specified by:

getForTarget in interface TargetDependingValue

Specified by:

getForTarget in interface TargetDependingParameter

Returns:

A Double holding the target star's declination.

getValue

public Number getValue()

Returns the actual target's hour angle in degrees, wrapped into a Double. Note that this method returns null if either the globals denoting the sidereal time or the ra target are missing.

Specified by:

getValue in interface Value

registerParameter

public void registerParameter(Parameter what)

Registers the required additional globals for the tau target. For this particular object, loacal sidereal time and target ra are required. Note that the argumental global is checked for being of instance types of SiderealTime or RaTarget, rather than querrying for the global name.

Specified by:

registerParameter in interface ParameterDepending

calculate

private Double calculate(double tdeg,
                         double ddeg)

Calculates the amount of the diurnal velocitry contribution to the barycentric velocity.

Parameters:

tdeg - Hour angle of target in degrees.

ddeg - Declination of target in degrees.