CssiSolarGeophysicalDataReadFromFile Method (String, Double, Boolean, Boolean) |
Processes the CSSI Space Weather file into a set of time varying geophysical data.
For more information on the format of this file, or to obtain updated files, see:
CSSI Space Weather Data.
Namespace:
AGI.Foundation.Celestial
Assembly:
AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static CssiSolarGeophysicalData ReadFromFile(
string filePath,
double obsTimeOfDay,
bool useApToComputeKp,
bool useDailyForGeoFlux
)
Public Shared Function ReadFromFile (
filePath As String,
obsTimeOfDay As Double,
useApToComputeKp As Boolean,
useDailyForGeoFlux As Boolean
) As CssiSolarGeophysicalData
public:
static CssiSolarGeophysicalData^ ReadFromFile(
String^ filePath,
double obsTimeOfDay,
bool useApToComputeKp,
bool useDailyForGeoFlux
)
static member ReadFromFile :
filePath : string *
obsTimeOfDay : float *
useApToComputeKp : bool *
useDailyForGeoFlux : bool -> CssiSolarGeophysicalData
Parameters
- filePath
- Type: SystemString
The full path and filename of the file containing the space weather data in the CSSI format. - obsTimeOfDay
- Type: SystemDouble
This is the time since the start of the calendar day, in seconds, when the observations are taken.
This is the time at which the daily values come into effect. Prior to this time, the previous days values are used.
By default, this is DefaultObservationTimeOfDay (20 hours). - useApToComputeKp
- Type: SystemBoolean
This indicates whether to use the Ap geomagnetic flux indices in the file to compute the Kp values.
By default, this is true. - useDailyForGeoFlux
- Type: SystemBoolean
Indicates that the variation in values every three hours for Ap and Kp
should be ignored and instead replaced with a constant daily value when calling ComputeThreeHourApValues(JulianDate) and
ComputeThreeHourKpValues(JulianDate).
Return Value
Type:
CssiSolarGeophysicalDataAn instance of the time varying space weather data.
Exceptions Exception | Condition |
---|
FormatException | Thrown if there was a problem with the format of the file, the version is prior to 1.1, or
if there were no data entries in the file. |
See Also