SightInfo

java.lang.Object
- util.PropertyContainer
- - astro.SightInfo

All Implemented Interfaces:

Cloneable, PropertySupplying
```
public class SightInfo
extends PropertyContainer
```
A small class that allows calculation of fundamental astronomical properties of an object at a given location. This includes time of opposition, culmination height, max. duration of observation etc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SightInfo.Print
A class to test the main astronomical info.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SightInfo.Print` A class to test the main astronomical info.

Field Summary

Fields
Modifier and Type	Field and Description
`private static double`	`DEFDURATION` Default instant duration.
`private static double`	`DEFHELIACALHEIGHT` Default heliacal height of target .
`private static double`	`DEFHELIACALSUN` Default heliacal height of sun .
`static String`	`KEY_DURATION` The minimal observing period.
`static String`	`KEY_HELIACALHEIGHT` The minimum allowed target height at the day of heliacal rise/set.
`static String`	`KEY_HELIACALSUN` The minimum allowed solar height at the day of heliacal rise/set.
`static String`	`KEY_LATITUDE` The latitude of the site.
`private Star`	`star` The star of the field, i.e.

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

SightInfo(Map<String,String> prop)
Default constructor.

Constructors
Constructor and Description
`SightInfo(Map<String,String> prop)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getCulminationHeight()` Returns culmination height in degree or NaN if not applicabale.
`Date`	`getHeliacalRise()` Returns the date in the current year when the target has its heliacal rise, which means it is the first morning it is visible.
`Date`	`getHeliacalSet()` Returns the date in the current year when the target has its heliacal set, which means it is the last evening it is visible.
`double`	`getObservableSpanInNight()` Returns the maximum observation span in seconds this target can acheive in the night of opposition.
`double`	`getObservableSpanInYear()` Returns the days this target is visible in a year.
`Date`	`getOpposition()` Returns the date in the current year when the target is in opposition.
`void`	`setDuration(double tsec)` Sets the duration of the observation in seconds
`void`	`setHeliacalHeight(double htarget)` Sets the heliacal target height on rise and set.
`void`	`setHeliacalSunHeight(double h)` Sets the heliacal sun height on rise and set.
`void`	`setLatitude(double lat)` Sets the latitude of the sight info.
`void`	`setObject(Star rade)` Sets the object of the sight info.

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, clone, 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, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_HELIACALSUN
```
public static final String KEY_HELIACALSUN
```
    The minimum allowed solar height at the day of heliacal rise/set.
    
    See Also:
    
    Constant Field Values
  - KEY_HELIACALHEIGHT
```
public static final String KEY_HELIACALHEIGHT
```
    The minimum allowed target height at the day of heliacal rise/set.
    
    See Also:
    
    Constant Field Values
  - KEY_DURATION
```
public static final String KEY_DURATION
```
    The minimal observing period.
    
    See Also:
    
    Constant Field Values
  - KEY_LATITUDE
```
public static final String KEY_LATITUDE
```
    The latitude of the site.
    
    See Also:
    
    Constant Field Values
  - DEFHELIACALSUN
```
private static final double DEFHELIACALSUN
```
    Default heliacal height of sun .
    
    See Also:
    
    Constant Field Values
  - DEFHELIACALHEIGHT
```
private static final double DEFHELIACALHEIGHT
```
    Default heliacal height of target .
    
    See Also:
    
    Constant Field Values
  - DEFDURATION
```
private static final double DEFDURATION
```
    Default instant duration.
    
    See Also:
    
    Constant Field Values
  - star
```
private Star star
```
    The star of the field, i.e. the target.
- Constructor Detail
  - SightInfo
```
public SightInfo(Map<String,String> prop)
```
    Default constructor.
- Method Detail
  - setLatitude
```
public void setLatitude(double lat)
```
    Sets the latitude of the sight info. Updates the relevant labels.
  - setHeliacalSunHeight
```
public void setHeliacalSunHeight(double h)
```
    Sets the heliacal sun height on rise and set.
  - setHeliacalHeight
```
public void setHeliacalHeight(double htarget)
```
    Sets the heliacal target height on rise and set.
  - setDuration
```
public void setDuration(double tsec)
```
    Sets the duration of the observation in seconds
    
    Parameters:
    
    tsec - Minimum observing time in seconds.
  - setObject
```
public void setObject(Star rade)
```
    Sets the object of the sight info. Updates the relevant labels.
  - getCulminationHeight
```
public double getCulminationHeight()
```
    Returns culmination height in degree or NaN if not applicabale.
  - getObservableSpanInNight
```
public double getObservableSpanInNight()
```
    Returns the maximum observation span in seconds this target can acheive in the night of opposition.
  - getObservableSpanInYear
```
public double getObservableSpanInYear()
```
    Returns the days this target is visible in a year.
  - getHeliacalRise
```
public Date getHeliacalRise()
```
    Returns the date in the current year when the target has its heliacal rise, which means it is the first morning it is visible. In the morning it must at least be KEY_HELIACALHEIGHT degrees above the horizon, and the sun is at least KEY_HELIACALSUN degrees below the horizon.
  - getHeliacalSet
```
public Date getHeliacalSet()
```
    Returns the date in the current year when the target has its heliacal set, which means it is the last evening it is visible. In this evening it must at least be KEY_HELIACALHEIGHT degrees above the horizon, and the sun is at least KEY_HELIACALSUN degrees below the horizon.
  - getOpposition
```
public Date getOpposition()
```
    Returns the date in the current year when the target is in opposition. Also defined, if the target is not visible that day.

Class SightInfo

Nested Class Summary

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_HELIACALSUN

KEY_HELIACALHEIGHT

KEY_DURATION

KEY_LATITUDE

DEFHELIACALSUN

DEFHELIACALHEIGHT

DEFDURATION

star

Constructor Detail

SightInfo

Method Detail

setLatitude

setHeliacalSunHeight

setHeliacalHeight

setDuration

setObject

getCulminationHeight

getObservableSpanInNight

getObservableSpanInYear

getHeliacalRise

getHeliacalSet

getOpposition