Package org.orekit.models.earth.atmosphere.data

Class MarshallSolarActivityFutureEstimationLoader

java.lang.Object

org.orekit.models.earth.atmosphere.data.AbstractSolarActivityDataLoader<MarshallSolarActivityFutureEstimationLoader.LineParameters>

org.orekit.models.earth.atmosphere.data.MarshallSolarActivityFutureEstimationLoader

All Implemented Interfaces:

DataLoader

public class MarshallSolarActivityFutureEstimationLoader
extends AbstractSolarActivityDataLoader<MarshallSolarActivityFutureEstimationLoader.LineParameters>

This class reads solar activity data needed by atmospheric models: F107 solar flux, Ap and Kp indexes.

The data are retrieved through the NASA Marshall Solar Activity Future Estimation (MSAFE) as estimates of monthly F10.7 Mean solar flux and Ap geomagnetic parameter. The data can be retrieved at the NASA Marshall Solar Activity website. Here Kp indices are deduced from Ap indexes, which in turn are tabulated equivalent of retrieved Ap values.

If several MSAFE files are available, some dates may appear in several files (for example August 2007 is in all files from the first one published in March 1999 to the February 2008 file). In this case, the data from the most recent file is used and the older ones are discarded. The date of the file is assumed to be 6 months after its first entry (which explains why the file having August 2007 as its first entry is the February 2008 file). This implies that MSAFE files must not be edited to change their time span, otherwise this would break the old entries overriding mechanism.

References

1. Jacchia, L. G. "CIRA 1972, recent atmospheric models, and improvements in progress." COSPAR, 21st Plenary Meeting. Vol. 1. 1978.

Author:

Bruno Revelin, Luc Maisonobe, Evan Ward, Pascal Parraud, Vincent Cucchietti

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarshallSolarActivityFutureEstimationLoader.LineParameters	Container class for Solar activity indexes.

Constructor Summary

Constructors

Constructor	Description
MarshallSolarActivityFutureEstimationLoader(MarshallSolarActivityFutureEstimation.StrengthLevel strengthLevel)	Simple constructor.
MarshallSolarActivityFutureEstimationLoader(MarshallSolarActivityFutureEstimation.StrengthLevel strengthLevel, TimeScale utc)	Constructor that allows specifying the source of the MSAFE auxiliary data files.

Method Summary

Modifier and Type	Method	Description
SortedSet<MarshallSolarActivityFutureEstimationLoader.LineParameters>	getDataSet()	Get the data set.
void	loadData(InputStream input, String name)	Load data from a stream.

Methods inherited from class org.orekit.models.earth.atmosphere.data.AbstractSolarActivityDataLoader

getMaxDate, getMinDate, getUTC, setMaxDate, setMinDate, stillAcceptsData

Methods inherited from class java.lang.Object

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

Constructor Detail

MarshallSolarActivityFutureEstimationLoader

@DefaultDataContext
public MarshallSolarActivityFutureEstimationLoader(MarshallSolarActivityFutureEstimation.StrengthLevel strengthLevel)

Simple constructor. This constructor uses the default data context.

Parameters:

strengthLevel - selected strength level of activity

MarshallSolarActivityFutureEstimationLoader

public MarshallSolarActivityFutureEstimationLoader(MarshallSolarActivityFutureEstimation.StrengthLevel strengthLevel,
                                                   TimeScale utc)

Constructor that allows specifying the source of the MSAFE auxiliary data files.

Parameters:

strengthLevel - selected strength level of activity

utc - UTC time scale.

Since:

10.1

Method Detail

loadData

public void loadData(InputStream input,
                     String name)
              throws IOException,
                     ParseException,
                     OrekitException

Load data from a stream.

Parameters:

input - data input stream

name - name of the file (or zip entry)

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed or if some loader specific error occurs

OrekitException

getDataSet

public SortedSet<MarshallSolarActivityFutureEstimationLoader.LineParameters> getDataSet()

Description copied from class: AbstractSolarActivityDataLoader

Get the data set.

Specified by:

getDataSet in class AbstractSolarActivityDataLoader<MarshallSolarActivityFutureEstimationLoader.LineParameters>

Returns:

the data set