Earth Observation Mission CFI Software Visibility Software User Manual |
Class to make operations involving a swath for star visibility. More...
Public Member Functions | |
SwathStar () | |
Empty Class constructor. | |
SwathStar (const OrbitId &orbitId, string swathFileUpper, string swathFileLower) throw (CfiError) | |
Class constructor with parameters, for star visibility with STF file. | |
SwathStar (const OrbitId &orbitId, long orbitNum, string swathFileUpper, string swathFileLower) throw (CfiError) | |
Class constructor with parameters, for star visibility, with SDF file. | |
~SwathStar () throw (CfiError) | |
Class destructor. | |
void | set (const OrbitId &orbitId, string swathFileUpper, string swathFileLower) throw (CfiError) |
Set values of parameters, for star visibility, with STF file. | |
void | set (const OrbitId &orbitId, long orbitNum, string swathFileUpper, string swathFileLower) throw (CfiError) |
Set values of parameters, for star visibility, with SDF file. | |
VisibilityList | starVisTime (long startOrbit, long stopOrbit, string starId, string starDBFile, double minDuration, double &starRaDeg, double &starDecDeg) throw (CfiError) |
Calculate the visibility segments for which a star is visible from the satellite using a star database. | |
VisibilityList | starVisTime (long startOrbit, long stopOrbit, double starRa, double starDec, double minDuration, double &starRaDeg, double &starDecDeg) throw (CfiError) |
Calculate the visibility segments for which a star is visible from the satellite using the Right ascension and declination of a star. |
Class to make operations involving a swath for star visibility.
EECFI::SwathStar::SwathStar | ( | ) |
Empty Class constructor.
EECFI::SwathStar::SwathStar | ( | const OrbitId & | orbitId, | |
string | swathFileUpper, | |||
string | swathFileLower | |||
) | throw (CfiError) |
Class constructor with parameters, for star visibility with STF file.
orbitId | Orbit Id. | |
swathFileUpper | File name of the inertial swath-file for the appropiate instrument mode, which defines the upper limit of the FOV. | |
swathFileLower | File name of the inertial swath-file for the appropiate instrument mode, which defines the lower limit of the FOV. |
EECFI::SwathStar::SwathStar | ( | const OrbitId & | orbitId, | |
long | orbitNum, | |||
string | swathFileUpper, | |||
string | swathFileLower | |||
) | throw (CfiError) |
Class constructor with parameters, for star visibility, with SDF file.
orbitId | Orbit Id. | |
orbitNum | Swath points are generated every "orbitNum" orbits. | |
swathFileUpper | File name of the inertial swath-file for the appropiate instrument mode, which defines the upper limit of the FOV. | |
swathFileLower | File name of the inertial swath-file for the appropiate instrument mode, which defines the lower limit of the FOV. |
EECFI::SwathStar::~SwathStar | ( | ) | throw (CfiError) |
Class destructor.
void EECFI::SwathStar::set | ( | const OrbitId & | orbitId, | |
string | swathFileUpper, | |||
string | swathFileLower | |||
) | throw (CfiError) |
Set values of parameters, for star visibility, with STF file.
orbitId | Orbit Id. | |
swathFileUpper | File name of the inertial swath-file for the appropiate instrument mode, which defines the upper limit of the FOV. | |
swathFileLower | File name of the inertial swath-file for the appropiate instrument mode, which defines the lower limit of the FOV. |
void EECFI::SwathStar::set | ( | const OrbitId & | orbitId, | |
long | orbitNum, | |||
string | swathFileUpper, | |||
string | swathFileLower | |||
) | throw (CfiError) |
Set values of parameters, for star visibility, with SDF file.
orbitId | Orbit Id. | |
orbitNum | Swath points are generated every "orbitNum" orbits. | |
swathFileUpper | File name of the inertial swath-file for the appropiate instrument mode, which defines the upper limit of the FOV. | |
swathFileLower | File name of the inertial swath-file for the appropiate instrument mode, which defines the lower limit of the FOV. |
References EECFI::CfiError::addMsg().
VisibilityList EECFI::SwathStar::starVisTime | ( | long | startOrbit, | |
long | stopOrbit, | |||
string | starId, | |||
string | starDBFile, | |||
double | minDuration, | |||
double & | starRaDeg, | |||
double & | starDecDeg | |||
) | throw (CfiError) |
Calculate the visibility segments for which a star is visible from the satellite using a star database.
startOrbit | First absolute orbit, segment filter; segments will be filtered as from the beginning of first orbit. First Orbit for the orbit initialization will be used when absolute orbit is set to zero. Allowed range: =0; or >=start_osf. | |
stopOrbit | Last absolute orbit, segment filter. For orbitId initialized with orbital changes, when stopOrbit = 0 the stopOrbit will be set to the minimum value between:
Allowed range: =0; or >=start_osf. | |
starId | Identification of the star, as defined in starDBFile. | |
starDBFile | File name of the star database file. | |
minDuration | Minimum duration for segments; only segments with a duration longer than minDuration will be given as output [s]. Allowed range: >=0. | |
starRaDeg | [OUTPUT] Right Ascension of the star, in TOD, for the UTC halfway starOrbit and stopOrbit [deg]. | |
starDecDeg | [OUTPUT] Declination of the star, in TOD, for the UTC halfway starOrbit and stopOrbit [deg] |
VisibilityList EECFI::SwathStar::starVisTime | ( | long | startOrbit, | |
long | stopOrbit, | |||
double | starRa, | |||
double | starDec, | |||
double | minDuration, | |||
double & | starRaDeg, | |||
double & | starDecDeg | |||
) | throw (CfiError) |
Calculate the visibility segments for which a star is visible from the satellite using the Right ascension and declination of a star.
startOrbit | First absolute orbit, segment filter; segments will be filtered as from the beginning of first orbit. First Orbit for the orbit initialization will be used when absolute orbit is set to zero. Allowed range: =0; or >=start_osf. | |
stopOrbit | Last absolute orbit, segment filter. For orbitId initialized with orbital changes, when stopOrbit = 0 the stopOrbit will be set to the minimum value between:
Allowed range: =0; or >=start_osf. | |
starRa | Right ascension of star, in TOD. Only used if starDBFile is not equal to the empty string ("") [deg]. Allowed range: (-180., 180). | |
starDec | Declination of star, in TOD. Only used if starDBFile is not equal to the empty string ("") [deg]. Allowed range: (-90., 90). | |
minDuration | Minimum duration for segments; only segments with a duration longer than minDuration will be given as output [s]. Allowed range: >=0. | |
starRaDeg | [OUTPUT] Right Ascension of the star, in TOD, for the UTC halfway starOrbit and stopOrbit [deg]. | |
starDecDeg | [OUTPUT] Declination of the star, in TOD, for the UTC halfway starOrbit and stopOrbit [deg] |