DEIMOS
Earth Observation Mission CFI Software
Visibility Software User Manual
ESA

EECFI Namespace Reference

Namespaces

namespace  VisibilityFunc
 

Namespace for functions that do not belong to any Visibility class.


Classes

class  OrbitExtra
 Class to extract orbital extra information. More...
class  Swath
 Class to make operations involving a swath for zone and station visibility. More...
class  SwathId
 Class that stores the Swath data. More...
class  SwathStar
 Class to make operations involving a swath for star visibility. More...
class  TimelineInterval
 Class TimelineInterval (C++ API) === xv_timeline_interval (in C API). More...
class  VisExtraInfo
 Base class for visibility extra information. More...
class  ZoneExtraInfo
 Additional information to visibility segments computed for one zone. More...
class  StationExtraInfo
 Additional information to visibility segments computed for one station. More...
class  MultiZonesExtraInfo
 Additional information to visibility segments computed for multiple zones. More...
class  MultiStationsExtraInfo
 Additional information to visibility segments computed for multiple stations. More...
class  MappingExtraInfo
 Additional information to visibility segments computed for mapping. More...
class  StarExtraInfo
 Additional information to star visibility segments. More...
class  OrbitExtraInfo
 Orbit extra information. More...
class  ScfAppear
 Swath Control File appearance data structure. More...
class  SwathInfo
 Swath information. More...
class  SwathIdData
 Swath id data information. More...
class  VisTime
 Time container. More...
class  VisTimeInterval
 Visibility time interval. More...
class  ZoneInfo
 Class to store information of a zone. More...
class  ZoneInfoList
 Class to store information of a list of zones. More...
class  StationInfo
 Class to store information of a station. More...
class  StationInfoList
 Class to store information of a list of stations. More...
class  SwathPoint
 Swath point coordinates. More...
class  SwathPointList
 Swath point list. More...
class  VisibilitySegment
 Class to store a visibility segment. More...
class  ZoneCoverageIn
 Input for SwathId::zonevistimeCoverage. More...
class  ZoneCoverageOut
 Output for SwathId::zonevistimeCoverage. More...

Typedefs

typedef std::vector
< VisibilitySegment
VisibilityList
 Class to store list of visibility segments.

Enumerations

enum  OrbitTypeEnum {
  XVCFI_ORBIT_ABS = 0,
  XVCFI_ORBIT_REL = 1
}
 

Type of orbit input.

More...
enum  SwathTypeEnum {
  XVCFI_STF = 0,
  XVCFI_SDF = 1
}
 

Swath type.

More...
enum  CoverageEnum {
  XVCFI_COMPLETE = 0,
  XVCFI_LEFT = 1,
  XVCFI_RIGHT = 2,
  XVCFI_BOTH = 3
}
 

Coverage.

More...
enum  MaskEnum {
  XVCFI_COMBINE = 0,
  XVCFI_AOS_LOS = 1,
  XVCFI_PHYSICAL = 2,
  XVCFI_FROM_FILE = 3
}
 

Ground station mask used to define visibility in stationVistime.

More...
enum  CoverageStarEnum {
  XVCFI_STAR_UNDEFINED = 0,
  XVCFI_STAR_UPPER = 1,
  XVCFI_STAR_LOWER = 2,
  XVCFI_STAR_LEFT = 3,
  XVCFI_STAR_RIGHT = 4
}
 

Indicate the type of coverage as result of a visibility segment from starVisTime.

More...
enum  TimeSegmentsOrbitDirectionEnum {
  XVCFI_ASCENDING = 0,
  XVCFI_DESDENDING = 1
}
 

Direction of segments.

More...
enum  VisibilityTypeEnum {
  XVCFI_NO_VIS = -1,
  XVCFI_ZONE_VIS = 0,
  XVCFI_STATION_VIS = 1,
  XVCFI_MULTI_ZONES_VIS = 2,
  XVCFI_MULTI_STATIONS_VIS = 3,
  XVCFI_MAPPING_VIS = 4,
  XVCFI_SC_VIS = 5,
  XVCFI_CELESTIAL_BODY_VIS = 6,
  XVCFI_STAR_VIS = 7
}
 

Type of visibility.

More...
enum  SatIdVisibilityEnum {
  XVCFI_SAT_DEFAULT = XLCFI_SAT_DEFAULT,
  XVCFI_SAT_DEFAULT1 = XLCFI_SAT_DEFAULT1,
  XVCFI_SAT_DEFAULT2 = XLCFI_SAT_DEFAULT2,
  XVCFI_SAT_DEFAULT3 = XLCFI_SAT_DEFAULT3,
  XVCFI_SAT_DEFAULT4 = XLCFI_SAT_DEFAULT4,
  XVCFI_SAT_DEFAULT5 = XLCFI_SAT_DEFAULT5,
  XVCFI_SAT_DEFAULT6 = XLCFI_SAT_DEFAULT6,
  XVCFI_SAT_DEFAULT7 = XLCFI_SAT_DEFAULT7,
  XVCFI_SAT_DEFAULT8 = XLCFI_SAT_DEFAULT8,
  XVCFI_SAT_DEFAULT9 = XLCFI_SAT_DEFAULT9,
  XVCFI_SAT_ERS1 = XLCFI_SAT_ERS1,
  XVCFI_SAT_ERS2 = XLCFI_SAT_ERS2,
  XVCFI_SAT_ENVISAT = XLCFI_SAT_ENVISAT,
  XVCFI_SAT_METOP1 = XLCFI_SAT_METOP1,
  XVCFI_SAT_METOP2 = XLCFI_SAT_METOP2,
  XVCFI_SAT_METOP3 = XLCFI_SAT_METOP3,
  XVCFI_SAT_CRYOSAT = XLCFI_SAT_CRYOSAT,
  XVCFI_SAT_ADM = XLCFI_SAT_ADM,
  XVCFI_SAT_GOCE = XLCFI_SAT_GOCE,
  XVCFI_SAT_SMOS = XLCFI_SAT_SMOS,
  XVCFI_SAT_TERRASAR = XLCFI_SAT_TERRASAR,
  XVCFI_SAT_EARTHCARE = XLCFI_SAT_EARTHCARE,
  XVCFI_SAT_SWARM_A = XLCFI_SAT_SWARM_A,
  XVCFI_SAT_SWARM_B = XLCFI_SAT_SWARM_B,
  XVCFI_SAT_SWARM_C = XLCFI_SAT_SWARM_C,
  XVCFI_SAT_SENTINEL_1A = XLCFI_SAT_SENTINEL_1A,
  XVCFI_SAT_SENTINEL_1B = XLCFI_SAT_SENTINEL_1B,
  XVCFI_SAT_SENTINEL_2 = XLCFI_SAT_SENTINEL_2,
  XVCFI_SAT_SENTINEL_3 = XLCFI_SAT_SENTINEL_3,
  XVCFI_SAT_SEOSAT = XLCFI_SAT_SEOSAT,
  XVCFI_SAT_SENTINEL_1C = XLCFI_SAT_SENTINEL_1C,
  XVCFI_SAT_SENTINEL_2A = XLCFI_SAT_SENTINEL_2A,
  XVCFI_SAT_SENTINEL_2B = XLCFI_SAT_SENTINEL_2B,
  XVCFI_SAT_SENTINEL_2C = XLCFI_SAT_SENTINEL_2C,
  XVCFI_SAT_SENTINEL_3A = XLCFI_SAT_SENTINEL_3A,
  XVCFI_SAT_SENTINEL_3B = XLCFI_SAT_SENTINEL_3B,
  XVCFI_SAT_SENTINEL_3C = XLCFI_SAT_SENTINEL_3C,
  XVCFI_SAT_JASON_CSA = XLCFI_SAT_JASON_CSA,
  XVCFI_SAT_JASON_CSB = XLCFI_SAT_JASON_CSB,
  XVCFI_SAT_METOP_SG_A1 = XLCFI_SAT_METOP_SG_A1,
  XVCFI_SAT_METOP_SG_A2 = XLCFI_SAT_METOP_SG_A2,
  XVCFI_SAT_METOP_SG_A3 = XLCFI_SAT_METOP_SG_A3,
  XVCFI_SAT_METOP_SG_B1 = XLCFI_SAT_METOP_SG_B1,
  XVCFI_SAT_METOP_SG_B2 = XLCFI_SAT_METOP_SG_B2,
  XVCFI_SAT_METOP_SG_B3 = XLCFI_SAT_METOP_SG_B3,
  XVCFI_SAT_SENTINEL_5P = XLCFI_SAT_SENTINEL_5P,
  XVCFI_SAT_BIOMASS = XLCFI_SAT_BIOMASS,
  XVCFI_SAT_SENTINEL_5 = XLCFI_SAT_SENTINEL_5,
  XVCFI_SAT_SAOCOM_CS = XLCFI_SAT_SAOCOM_CS,
  XVCFI_SAT_FLEX = XLCFI_SAT_FLEX,
  XVCFI_SAT_SENTINEL_6A = XLCFI_SAT_SENTINEL_6A,
  XVCFI_SAT_SENTINEL_6B = XLCFI_SAT_SENTINEL_6B,
  XVCFI_SAT_CIMR = XLCFI_SAT_CIMR,
  XVCFI_SAT_ROSEL = XLCFI_SAT_ROSEL,
  XVCFI_SAT_CHIME = XLCFI_SAT_CHIME,
  XVCFI_SAT_CRISTAL = XLCFI_SAT_CRISTAL,
  XVCFI_SAT_CO2M = XLCFI_SAT_CO2M,
  XVCFI_SAT_LSTM = XLCFI_SAT_LSTM,
  XVCFI_SAT_FORUM = XLCFI_SAT_FORUM,
  XVCFI_SAT_TRUTHS = XLCFI_SAT_TRUTHS,
  XVCFI_SAT_GENERIC = XLCFI_SAT_GENERIC,
  XVCFI_SAT_GENERIC_GEO = XLCFI_SAT_GENERIC_GEO,
  XVCFI_SAT_MTG = XLCFI_SAT_MTG,
  XVCFI_SAT_GENERIC_MEO = XLCFI_SAT_GENERIC_MEO
}
 

Satellite ID.

More...
enum  XVSwathInitEnum {
  XVCFI_FILE_AUTO,
  XVCFI_FILE_SDF,
  XVCFI_FILE_STF,
  XVCFI_SDF_DATA,
  XVCFI_STF_DATA
}
 

Swath initialization mode.

More...
enum  XVZoneTypeEnum {
  XVCFI_USE_ZONE_DB_FILE,
  XVCFI_USE_ZONE_DATA
}
 

Zone selection.

More...
enum  XVComputeFlagEnum {
  XVCFI_DO_NOT_COMPUTE = 0,
  XVCFI_COMPUTE = 1
}
 

Visibility extra computations flag.

More...
enum  XVStationTypeEnum {
  XVCFI_USE_STATION_FILE,
  XVCFI_USE_STATION_DATA,
  XVCFI_USE_STATION_FILE_AND_MASK_OVERRIDE,
  XVCFI_USE_STATION_DATA_AND_MASK_OVERRIDE
}
 

Station selection.

More...
enum  XVTimeTypeEnum {
  XVCFI_UTC_TYPE,
  XVCFI_ORBIT_TYPE,
  XVCFI_BOTH_TYPE
}
 

Time type.

More...
enum  XVTypeCoverageEnum {
  XVCFI_COVERAGE_FIXED_DISTANCE,
  XVCFI_COVERAGE_PERCENTAGE_PRECISION
}
 

Input type for coverage computation.

More...
enum  XVTypeCelestialBodyEnum {
  XVCFI_SUN,
  XVCFI_MOON
}

Detailed Description

This file contains generic data that can be used as input/output in the classes of EOCFI Visibility library.


Typedef Documentation

Class to store list of visibility segments.


Enumeration Type Documentation

Coverage.

Enumerator:
XVCFI_COMPLETE 

Zone completely covered by swath.

XVCFI_LEFT 

LEFT extreme transition found by ZONEVISTIME.

XVCFI_RIGHT 

RIGHT extreme transition found by ZONEVISTIME.

XVCFI_BOTH 

BOTH transitions found by ZONEVISTIME.

Indicate the type of coverage as result of a visibility segment from starVisTime.

Enumerator:
XVCFI_STAR_UNDEFINED 

Visibility starts/ends at the first/last FOV in starVisTime.

XVCFI_STAR_UPPER 

Visibility starts/ends at the upper FOV in starVisTime.

XVCFI_STAR_LOWER 

Visibility starts/ends at the lower FOV in starVisTime.

XVCFI_STAR_LEFT 

Visibility starts/ends at the left FOV in starVisTime.

XVCFI_STAR_RIGHT 

Visibility starts/ends at the right FOV in starVisTime.

Ground station mask used to define visibility in stationVistime.

Enumerator:
XVCFI_COMBINE 

Combination of AOS, LOS and physical mask.

XVCFI_AOS_LOS 

Combination of AOS/LOS only.

XVCFI_PHYSICAL 

Consider physical mask only.

XVCFI_FROM_FILE 

Consider mask form GS DB.

Type of orbit input.

Enumerator:
XVCFI_ORBIT_ABS 

Absolute orbits.

XVCFI_ORBIT_REL 

Relative orbits.

Satellite ID.

Enumerator:
XVCFI_SAT_DEFAULT 
XVCFI_SAT_DEFAULT1 
XVCFI_SAT_DEFAULT2 
XVCFI_SAT_DEFAULT3 
XVCFI_SAT_DEFAULT4 
XVCFI_SAT_DEFAULT5 
XVCFI_SAT_DEFAULT6 
XVCFI_SAT_DEFAULT7 
XVCFI_SAT_DEFAULT8 
XVCFI_SAT_DEFAULT9 
XVCFI_SAT_ERS1 
XVCFI_SAT_ERS2 
XVCFI_SAT_ENVISAT 
XVCFI_SAT_METOP1 
XVCFI_SAT_METOP2 
XVCFI_SAT_METOP3 
XVCFI_SAT_CRYOSAT 
XVCFI_SAT_ADM 
XVCFI_SAT_GOCE 
XVCFI_SAT_SMOS 
XVCFI_SAT_TERRASAR 
XVCFI_SAT_EARTHCARE 
XVCFI_SAT_SWARM_A 
XVCFI_SAT_SWARM_B 
XVCFI_SAT_SWARM_C 
XVCFI_SAT_SENTINEL_1A 
XVCFI_SAT_SENTINEL_1B 
XVCFI_SAT_SENTINEL_2 
XVCFI_SAT_SENTINEL_3 
XVCFI_SAT_SEOSAT 
XVCFI_SAT_SENTINEL_1C 
XVCFI_SAT_SENTINEL_2A 
XVCFI_SAT_SENTINEL_2B 
XVCFI_SAT_SENTINEL_2C 
XVCFI_SAT_SENTINEL_3A 
XVCFI_SAT_SENTINEL_3B 
XVCFI_SAT_SENTINEL_3C 
XVCFI_SAT_JASON_CSA 
XVCFI_SAT_JASON_CSB 
XVCFI_SAT_METOP_SG_A1 
XVCFI_SAT_METOP_SG_A2 
XVCFI_SAT_METOP_SG_A3 
XVCFI_SAT_METOP_SG_B1 
XVCFI_SAT_METOP_SG_B2 
XVCFI_SAT_METOP_SG_B3 
XVCFI_SAT_SENTINEL_5P 
XVCFI_SAT_BIOMASS 
XVCFI_SAT_SENTINEL_5 
XVCFI_SAT_SAOCOM_CS 
XVCFI_SAT_FLEX 
XVCFI_SAT_SENTINEL_6A 
XVCFI_SAT_SENTINEL_6B 
XVCFI_SAT_CIMR 
XVCFI_SAT_ROSEL 
XVCFI_SAT_CHIME 
XVCFI_SAT_CRISTAL 
XVCFI_SAT_CO2M 
XVCFI_SAT_LSTM 
XVCFI_SAT_FORUM 
XVCFI_SAT_TRUTHS 
XVCFI_SAT_GENERIC 
XVCFI_SAT_GENERIC_GEO 
XVCFI_SAT_MTG 
XVCFI_SAT_GENERIC_MEO 

Swath type.

Enumerator:
XVCFI_STF 
XVCFI_SDF 

Direction of segments.

Enumerator:
XVCFI_ASCENDING 
XVCFI_DESDENDING 

Type of visibility.

Enumerator:
XVCFI_NO_VIS 

No visibility segments computed.

XVCFI_ZONE_VIS 

Zone visibility segments.

XVCFI_STATION_VIS 

Station visibility segments.

XVCFI_MULTI_ZONES_VIS 

Multiple zones visibility segments.

XVCFI_MULTI_STATIONS_VIS 

Multiple stations visibility segments.

XVCFI_MAPPING_VIS 

Mapping visibility segments.

XVCFI_SC_VIS 

S/C visibility.

XVCFI_CELESTIAL_BODY_VIS 

Celestial body visibility.

XVCFI_STAR_VIS 

Star visibility.

Visibility extra computations flag.

Enumerator:
XVCFI_DO_NOT_COMPUTE 

Do not compute extra information.

XVCFI_COMPUTE 

Compute extra information.

Station selection.

Enumerator:
XVCFI_USE_STATION_FILE 

Use station file.

XVCFI_USE_STATION_DATA 

Use station data.

XVCFI_USE_STATION_FILE_AND_MASK_OVERRIDE 

Use default mask with station file.

XVCFI_USE_STATION_DATA_AND_MASK_OVERRIDE 

Use default mask with station data.

Swath initialization mode.

Enumerator:
XVCFI_FILE_AUTO 

Automatic file initialization.

XVCFI_FILE_SDF 
XVCFI_FILE_STF 

Swath definition file initialization.

XVCFI_SDF_DATA 

Swath template file initialization.

Swath definition data initialization.

XVCFI_STF_DATA 

Swath template data initialization.

Time type.

Enumerator:
XVCFI_UTC_TYPE 

Only UTC time info is provided.

XVCFI_ORBIT_TYPE 

Only orbit info is provided.

XVCFI_BOTH_TYPE 

UTC time and orbit info is provided.

Enumerator:
XVCFI_SUN 

Celestial body: Sun.

XVCFI_MOON 

Celestial body: Moon.

Input type for coverage computation.

Enumerator:
XVCFI_COVERAGE_FIXED_DISTANCE 

Computation with fixed distance between points.

XVCFI_COVERAGE_PERCENTAGE_PRECISION 

Computation with a percentage of precision.

Zone selection.

Enumerator:
XVCFI_USE_ZONE_DB_FILE 

Use zone database.

XVCFI_USE_ZONE_DATA 

Use zone data.


Generated on Mon Dec 11 2023 13:27:39 for by doxygen 1.7.1