OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <VcstTerrainCorrect.h>

Public Member Functions

 VcstTerrainCorrect ()
 
virtual ~VcstTerrainCorrect ()
 
int terrainCorrection (const float inLat, const float inLon, const float inSatAzm, const float inSatZen, const double inRPos[VEC_SIZE], VcstCmnGeo *cmnGeoPtr, float &outEgs, float &outLat, float &outLon, float &outHgt, float &outSatAzm, float &outSatZen, float &outRange)
 
int getTerrainInfo (const float inLat, const float inLon, VcstCmnGeo *cmnGeoPtr, LOSPointType &outPoint)
 

Detailed Description

Definition at line 191 of file VcstTerrainCorrect.h.

Constructor & Destructor Documentation

◆ VcstTerrainCorrect()

Constructor

◆ ~VcstTerrainCorrect()

virtual ~VcstTerrainCorrect ( )
virtual

Destructor

Member Function Documentation

◆ getTerrainInfo()

int getTerrainInfo ( const float  inLat,
const float  inLon,
VcstCmnGeo cmnGeoPtr,
LOSPointType outPoint 
)

This function will retrieve the MSL height for the ellipsoid intersection specified

Parameters
inLatInput latitude in radians
inLonInput longitude in radians
cmnGeoPtrvisibility to a cmn geo instance
outPointOutput structure containing terrain info
Returns
PRO_SUCCESS or PRO_FAIL

◆ terrainCorrection()

int terrainCorrection ( const float  inLat,
const float  inLon,
const float  inSatAzm,
const float  inSatZen,
const double  inRPos[VEC_SIZE],
VcstCmnGeo cmnGeoPtr,
float &  outEgs,
float &  outLat,
float &  outLon,
float &  outHgt,
float &  outSatAzm,
float &  outSatZen,
float &  outRange 
)

This is the main function for terrain correction. This function will return terrain corrected latitude/longitude and satellite zenith angle.

Parameters
inLatInput ellipsoid intersection latitude
inLonInput ellipsoid intersection longitude
inSatAzmInput satellite azimuth
inSatZenInput satellite zenith
inRPosInput ECR position
cmnGeoPtrvis to a cmn geo instance
outEgsOutput ellipsoid-geoid separation
outLatOutput terrain corrected latitude
outLonOutput terrain corrected longitude
outHgtOutput height above the surface
outSatAzmOutput terrain corrected satellite azimuth
outSatZenOutput terrain corrected satellite zenith
outRangeOutput terrain corrected satellite range
Returns
PRO_SUCCESS or PRO_FAIL

The documentation for this class was generated from the following file: