HiRISE

HiRISE.HiPlan.SPICE
Class Calc_Ls.Engine

java.lang.Object
  extended by HiRISE.HiPlan.SPICE.Calc_Ls.Engine
Enclosing class:
Calc_Ls

public static class Calc_Ls.Engine
extends Object

The solar longitude calculation engine.

Version:
1.5
Author:
Christian Schaller

Constructor Summary
Calc_Ls.Engine(State_File stateFile)
          Creates a new solar longitude calculation engine.
 
Method Summary
 Calc_Ls.Record calcLs(Date date)
          Computes a solar longitude record for the input date.
 List<Calc_Ls.Record> calcLs(List<Date> dates)
          Computes a list of solar longitude records for the input dates.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Calc_Ls.Engine

public Calc_Ls.Engine(State_File stateFile)
               throws SPICE_Exception
Creates a new solar longitude calculation engine. The LSK, PCK, and planetary SPK are loaded from the input state file; all other kernels are ignored.

Note that the state file's planetary SPK should cover the range of dates intended to be used with this engine. Specifically, the Sun, Earth, and Mars ephemerides contained within should cover that range.

Parameters:
stateFile - the reference state file for the computations.
Throws:
SPICE_Exception - if there is a problem initializing the SPICE system.
Method Detail

calcLs

public List<Calc_Ls.Record> calcLs(List<Date> dates)
Computes a list of solar longitude records for the input dates. If a record cannot be computed for a particular date for any reason, the date is skipped.

Parameters:
dates - the list of dates.
Returns:
a list of records, which may be smaller than the list of dates; it may even be empty, but not null.

calcLs

public Calc_Ls.Record calcLs(Date date)
Computes a solar longitude record for the input date. If the record cannot be computed for any reason, a null is returned. The most common reason for a failure to compute the record's data is a lack of coverage from the planetary SPK. The SPICE toolkit command-line application brief can examine the SPK and output the coverage.

Parameters:
date - the date in question.
Returns:
a solar longitude record or null.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona