stella.parameter
Class AzTarget

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.parameter.AbstractParameter
                  extended by stella.parameter.AbstractTargetParameter
                      extended by stella.parameter.AbstractTargetValue
                          extended by stella.parameter.AzTarget
All Implemented Interfaces:
Cloneable, Parameter, Increasing<Number>, TargetDependIncreasing<Number>, TargetDependingValue, ParameterDepending, TargetDepending, TargetDependingParameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class AzTarget
extends AbstractTargetValue
implements TargetDependIncreasing<Number>, ParameterDepending, Reloadable

Represents the azimuth of the actual target in degrees. The azimuth is counted astronomical, i.e. starting with zero at south, westwards. Using

 sin(a)cos(h)=sin(τ)cos(δ)
cos(a)cos(h)=cos(δ)sin(φ)cos(τ)-cos(φ)sin(δ)
 One gets the tan formular used here:
 
 
 tan(a)=sin(τ)/(sin(φ)cos(τ)-cos(φ)tan(δ)
 
Follows the general Value contract and returns a quantity in degrees. Three other globals must be registered, TauTarget, DecTarget, and Latitude.


Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
private  TargetDependingParameter dec
          The dec of the target, degrees.
private static String DEFDEC
          The default name of the solar ecliptical longitude 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 static String DEFTAU
          The default name of the sidereal parameter to use.
private static DecimalFormat df
          The formatter for the target height.
static String KEY_DEC
          The name of the solar ecliptical longitude to use.
static String KEY_LATITUDE
          The name of the latitude to use.
static String KEY_TAU
          The name of the sidereal time to use.
private  Value latitude
          The latitude of Teide, degrees.
private  TargetDependingParameter tau
          The actual hour angle 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
AzTarget(Map<String,String> info)
          Constructs a new airmass target object.
 
Method Summary
private  Double calcTime(double az, double phi, double dec, TargetDefinition target)
          Calculates the remaining time until a given az is reached.
private  Double calculate(Number tautarget, Number dectarget)
          Calculates the azimuth using the hour angle and the declination of the target.
 Double getAscendTime(Number until)
          Returns the remaining time in ms.
 Double getAscendTimeFor(TargetDefinition target, Number until)
          Returns the remaining time in ms.
 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 Z 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 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_TAU

public static final String KEY_TAU
The name of the sidereal time to use.

See Also:
Constant Field Values

KEY_LATITUDE

public static final String KEY_LATITUDE
The name of the latitude to use.

See Also:
Constant Field Values

KEY_DEC

public static final String KEY_DEC
The name of the solar ecliptical longitude to use.

See Also:
Constant Field Values

DEFNAME

public static final String DEFNAME
The default name of this value.

See Also:
Constant Field Values

DEFTAU

private static final String DEFTAU
The default name of the sidereal parameter to use.

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

DEFDEC

private static final String DEFDEC
The default name of the solar ecliptical longitude to use.

See Also:
Constant Field Values

tau

private TargetDependingParameter tau
The actual hour angle of the target, degrees.


dec

private TargetDependingParameter dec
The dec of the target, degrees.


latitude

private Value latitude
The latitude of Teide, degrees.


df

private static final DecimalFormat df
The formatter for the target height.

Constructor Detail

AzTarget

public AzTarget(Map<String,String> info)
Constructs a new airmass target 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

calculate

private Double calculate(Number tautarget,
                         Number dectarget)
Calculates the azimuth using the hour angle and the declination of the target. The latitude of the site must be registered first. Formular:
 tan(a)=sin(τ)/(sin(φ)cos(τ)-tan(δ)cos(φ))
 


registerParameter

public void registerParameter(Parameter what)
Registers the required additional globals for the Z target. For this particular object, target dec and tau and teide latitude are required. Note that the argumental global is checked for being of instance types of TauTarget, DecTarget or Latitude, rather than querrying for the global name.

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 tau and dec reference of this parameter. Note that this will set the target in the additional parameter, too.

Specified by:
registerTarget in interface TargetDepending

getAscendTime

public Double getAscendTime(Number until)
Returns the remaining time in ms. The height is only increasing if the hour angle of the target is negative. Only then a non-null Double will be returned.

Specified by:
getAscendTime in interface Increasing<Number>
Parameters:
until - The value in the future.
Returns:
A double carrying the remaining time or null if the time cannot be calculated.

getAscendTimeFor

public Double getAscendTimeFor(TargetDefinition target,
                               Number until)
Returns the remaining time in ms. The height is only increasing if the hour angle of the target is negative. Only then a non-null double will be returned.

Specified by:
getAscendTimeFor in interface TargetDependIncreasing<Number>
until - The value in the future.
Returns:
A double carrying the remaining time or null if the time cannot be calculated.

calcTime

private Double calcTime(double az,
                        double phi,
                        double dec,
                        TargetDefinition target)
Calculates the remaining time until a given az is reached. Always uses the ascend time of the hour angle definition. If the target definition handed over is null, the non-target depending version of the ascend time of tau is used.

Parameters:
az - Target azimuth of object in degrees.
phi - Latitude in degrees.
dec - Declination of object in degree.
target - If non-null the target depending time is used.