stella.parameter
Class ImageRotation

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NasmithImageRotation

public class ImageRotation
extends AbstractTargetValue
implements ParameterDepending, Reloadable

This parameter gives the amount of image rotation in the focal plane. It follows from pure geometric facts, that

   tan(θ0)=sin(τ)/(cos(δ)tan(φ)-sin(δ)cos(τ)),
   

where all the symbols have their usual meaning. Additionally, remember that you might experience additional from the place of mount: On the Nashmyth foci, you will have the height of the target to add on top of the rotation, see NasmithImageRotation.

This parameter is also known as the parallactic angle η, for the defining triangle, see

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

private static String	DEFDECLINATION The default name of the declination to use.
private static String	DEFHOURANGLE The default name of the hour angle to use.
private static String	DEFLATITUDE The default name of the latitude parameter to use.
static String	DEFNAME The default name of this value.
private TargetDependingParameter	delta The azimuth of the target, degrees.
static String	KEY_DECLINATION The name of the declination to use.
static String	KEY_HOURANGLE The name of the hour angle to use.
static String	KEY_LATITUDE The name of the latitude to use.
private Value	latitude The latitude of Teide, degrees.
private TargetDependingParameter	tau The azimuth of the target, degrees.

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

ImageRotation(Map info)
Constructs a image rotation object.

Method Summary

private Double	calculate(Number de, Number tau, Number phi) Calculates the image rotation angle in the focal plane.
Number	getForTarget(TargetDefinition star) Gets the declination of the target star.
Number	getValue() Returns the target's actual airmass, wrapped into a Double.
void	registerParameter(Parameter what) Registers the required additional globals for the altitudinal velocity.
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 airmass 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_LATITUDE

public static final String KEY_LATITUDE

The name of the latitude to use.

See Also:

Constant Field Values

KEY_DECLINATION

public static final String KEY_DECLINATION

The name of the declination to use.

See Also:

Constant Field Values

KEY_HOURANGLE

public static final String KEY_HOURANGLE

The name of the hour angle to use.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The default name of this value.

See Also:

Constant Field Values

DEFLATITUDE

private static final String DEFLATITUDE

The default name of the latitude parameter to use.

See Also:

Constant Field Values

DEFDECLINATION

private static final String DEFDECLINATION

The default name of the declination to use.

See Also:

Constant Field Values

DEFHOURANGLE

private static final String DEFHOURANGLE

The default name of the hour angle to use.

See Also:

Constant Field Values

delta

private TargetDependingParameter delta

The azimuth of the target, degrees.

tau

private TargetDependingParameter tau

The azimuth of the target, degrees.

latitude

private Value latitude

The latitude of Teide, degrees.

Constructor Detail

ImageRotation

public ImageRotation(Map info)

Constructs a image rotation object. Note that this global can only function correctly after the tau and dec of the target and the teide latitude 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 airmass of the actual target. This is a read-only variable, therefore this method throws an UnsupportedOperationException.

Specified by:

setValue in interface Value

Throws:

UnsupportedOperationException

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 target's actual airmass, wrapped into a Double. Note that this method returns null if either of the globals denoting the tau, dec of the target or the latitude is missing.

Specified by:

getValue in interface Value

registerParameter

public void registerParameter(Parameter what)

Registers the required additional globals for the altitudinal velocity. These are the latitude and the azimuth of the target.

Specified by:

registerParameter in interface ParameterDepending

registerTarget

public void registerTarget(TargetDefinition star)

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

Specified by:

registerTarget in interface TargetDepending

calculate

private Double calculate(Number de,
                         Number tau,
                         Number phi)

Calculates the image rotation angle in the focal plane.