RVC::SPOTOBJ Class Reference

Manages RVC::OBJTYPE_SpotHeader objects. More...

#include <rvc/spotobj.h>

Inheritance diagram for RVC::SPOTOBJ:
Inheritance graph
[legend]

List of all members.

Classes

struct  ANGULARRATE
 Angular rate structure. More...
struct  SPOTANGULARINFO
 SPOT angular info structure. More...

Public Member Functions

 SPOTOBJ (const RVC::SPOTOBJ &obj)
 SPOTOBJ ()
virtual ~SPOTOBJ ()
ERRVALUE GetAngleOfIncidence (double &Angle)
ERRVALUE GetAngularRates (SPOTANGULARINFO &Info)
ERRVALUE GetCalibration (double &A1, double &A2, double &A3)
ERRVALUE GetCenterLatLonPosition (CTRLPOINT3 &Center)
ERRVALUE GetEphemeris (DPOINT3D Pos[9], DPOINT3D Velocity[9], INT32 JulianDay[9], INT32 Seconds[9])
ERRVALUE GetGRSIdentification (int &K, int &J)
ERRVALUE GetHistogram (int Num, INT32 H[256])
ERRVALUE GetImageOrientation (double &Angle)
ERRVALUE GetInstrumentName (MISTRING &Name)
ERRVALUE GetJulianDate (int &day, double &seconds)
ERRVALUE GetLookDirections (double Angles[4])
ERRVALUE GetMapOrigin (DPOINT2D &Pos)
ERRVALUE GetMapProjection (MISTRING &Name)
ERRVALUE GetNumLinesColumns (int &numlins, int &numcols)
ERRVALUE GetPreprocessingLevel (MISTRING &Name)
ERRVALUE GetRevolutionNumber (int &Rev)
ERRVALUE GetSatelliteID (MISTRING &Name)
ERRVALUE GetSceneCorners (CTRLPOINT3 Corner[4])
ERRVALUE GetSpectralMode (MISTRING &ModeName)
ERRVALUE GetSpectralModePCode (MISTRING &PCode)
ERRVALUE GetSunAngles (double &Azimuth, double &Elevation)
ERRVALUE GetViewingDate (DATETIME &ViewDate)
RVC::SPOTOBJoperator= (const RVC::SPOTOBJ &rhs)

Detailed Description

Manages RVC::OBJTYPE_SpotHeader objects.

RVC Object Types that this class supports:

Default RVC Object Type for this class: RVC::OBJTYPE_SpotHeader

Valid parents for this class:


Constructor & Destructor Documentation

RVC::SPOTOBJ::SPOTOBJ (  ) 

Default constructor.

RVC::SPOTOBJ::SPOTOBJ ( const RVC::SPOTOBJ obj  ) 

Copy constructor.

virtual RVC::SPOTOBJ::~SPOTOBJ (  )  [virtual]

Destructor.


Member Function Documentation

ERRVALUE RVC::SPOTOBJ::GetAngleOfIncidence ( double &  Angle  ) 

Get angle between the look direction at the scene center and a line perpendicular to the reference ellipsoid.

NOTE: sign of the angle: < 0 (Left) - indicates that satellite passed to the west of the scene center when the scene was acquired. > 0 (Right) - it passed to the east of the scene center

Parameters:
Angle Angle returned in degrees
ERRVALUE RVC::SPOTOBJ::GetAngularRates ( SPOTANGULARINFO Info  ) 

Get satellite angular rates during scene acquisition.

NOTE: The SPOT bus measures angular rates once every 125 ms These rates are supplied to enable users who so desire to make certain corrections for themselves (notably for stereoplotting).

Parameters:
Info Data returned
ERRVALUE RVC::SPOTOBJ::GetCalibration ( double &  A1,
double &  A2,
double &  A3 
)

Get absolute calibration coefficients for computing the equivalent radiance of target objects from pixel brightness counts.

NOTE: For panchromatic images, this only A1 coefficients exists., for multispectral coefficients realte to spectral bands XS1, XS2, XS3 respectively. The mathematical relation used to compute radiance is: L(k) = x(k) / A(k); Where: L(k) is the SPOT radiance reqiured x(k) is a pixel brightness count A(k) is a absolute calibration coefficient corresponding to spectral band k. The absolute calibration coefficients A(k) are used to compesate for the difference in sensitivity of two instruments which could otherwise result in a slight difference in the mean pixel brightness counts of two images in a twin pair.

Parameters:
A1 Calibration for 1st channel
A2 Calibration for 2nd channel (meaningless for panchromatic)
A3 Calibration for 3rd channel (meaningless for panchromatic)
ERRVALUE RVC::SPOTOBJ::GetCenterLatLonPosition ( CTRLPOINT3 Center  ) 

Get Lat/Lon positions of the scene center.

Parameters:
Center Center position returned
ERRVALUE RVC::SPOTOBJ::GetEphemeris ( DPOINT3D  Pos[9],
DPOINT3D  Velocity[9],
INT32  JulianDay[9],
INT32  Seconds[9] 
)

Get satellite ephemeris data at the time of acquisition.

WARNING: depending upon the date and time of the scene center there are 8 or 9 sets of data (if there are 8 sets, nineth set has meaningless data) Ephemeris data are provided for nine points spanning scene acquisition, the points being separated by intervals of one minute. The X,Y,Z position is given relative to a reference frame defined as folows:

  • Z axis is the north direction of the Earth's polar axis
  • X axis is in equatorial plane and passes through the Greenwich meridian.
  • Y axis is in the equatorial plane and perpendicular to the X-axis
  • The 3 axes form a right hand reference system. Velocity vectors Vx, Vy, Vz are given relative to the same reference frame.
Parameters:
Pos 9 sets of satellite coordinates
Velocity 9 sets of veclocity data at these points
JulianDay 9 date parameters (Julian day number since Jan 1 1950)
Seconds 9 time parameters (time of the day in seconds)
ERRVALUE RVC::SPOTOBJ::GetGRSIdentification ( int &  K,
int &  J 
)

Get K,J coordinates in GRS (Grid Reference System).

Parameters:
K K-coordinate returned
J J-coordinate returned
ERRVALUE RVC::SPOTOBJ::GetHistogram ( int  Num,
INT32  H[256] 
)

Get histogram for the channels.

Parameters:
Num Channel number (0,1, or 2) for panchromatic images only first exists)
H Histogram data
ERRVALUE RVC::SPOTOBJ::GetImageOrientation ( double &  Angle  ) 

Get angle through which the image centerline direction must be rotated in order to align with true east at the center of the raw image.

NOTE: The angle given is the 90 degrees complement of the angle between the lines of the raw image and true north. the convention of the sign of the scene orientation angle is given in Appendix 7 of the SPOT manual.

Parameters:
Angle Angle returned (in degress)
ERRVALUE RVC::SPOTOBJ::GetInstrumentName ( MISTRING Name  ) 

Get name of the instrument used to acquire scene in question.

Parameters:
Name Instrument name returned ("HRV1" or "HRV2")
ERRVALUE RVC::SPOTOBJ::GetJulianDate ( int &  day,
double &  seconds 
)

Get Julian Date and Time of the scene center.

Parameters:
day Day number since 01/01/1950
seconds Seconds in the day
ERRVALUE RVC::SPOTOBJ::GetLookDirections ( double  Angles[4]  ) 

Get look direction of the CCD detectors corresponding to the first and last pixels of the first and last lines.

NOTE: HRV look angles are defined relative to the attitude reference frame The first angle gives look direction rotation about the pitch axis, the second about roll axis. The first two angles represent represent pitch angles for first and last pixels, the second two angles - roll angles for the first and last pixels. For a level 1A image the look angles corresponding to apixel of any position may be obtained by linear interpolation from the above values.

Parameters:
Angles Orientation angles
ERRVALUE RVC::SPOTOBJ::GetMapOrigin ( DPOINT2D Pos  ) 

Get map coordinate origin:map coordinates of the first pixel on the first line in case of level 2B.

Parameters:
Pos Coordinates (X,Y) in meters
ERRVALUE RVC::SPOTOBJ::GetMapProjection ( MISTRING Name  ) 

Get map projection used in the case of levels 2 or S2.

Parameters:
Name Map projection name (up to 32 characters)
ERRVALUE RVC::SPOTOBJ::GetNumLinesColumns ( int &  numlins,
int &  numcols 
)

Get number of lines and columns.

Parameters:
numlins Number of lines returned
numcols Number of columns returned
ERRVALUE RVC::SPOTOBJ::GetPreprocessingLevel ( MISTRING Name  ) 

Get preprocessing level.

Parameters:
Name Name of the level (1A, 1B, 2A, 2B, S1, S2)
ERRVALUE RVC::SPOTOBJ::GetRevolutionNumber ( int &  Rev  ) 

Get chronological number R of the revolution corresponding to the scene acquisition inside 26-day cycle.

Parameters:
Rev Number of revolutions returned
ERRVALUE RVC::SPOTOBJ::GetSatelliteID ( MISTRING Name  ) 

Get name and number of the satellite (for example SPOT2).

Parameters:
Name Satellite name returned
ERRVALUE RVC::SPOTOBJ::GetSceneCorners ( CTRLPOINT3  Corner[4]  ) 

Get Lat/Lon coordinates for the scene corners.

Parameters:
Corner Position of the the 4 scene corners
ERRVALUE RVC::SPOTOBJ::GetSpectralMode ( MISTRING ModeName  ) 

Get spectral mode.

Parameters:
ModeName Mode name ("XS" for multispectral or "PAN" for panchromatic )
ERRVALUE RVC::SPOTOBJ::GetSpectralModePCode ( MISTRING PCode  ) 

Get spectral mode P-code.

Parameters:
PCode Mode P-code
ERRVALUE RVC::SPOTOBJ::GetSunAngles ( double &  Azimuth,
double &  Elevation 
)

Get sun azimuth and elevation aangles at the scene center at the moment the center pixel is acquired as indicated in the "Viewing date".

(see GetViewingDate)

Parameters:
Azimuth Azimuth angle returned in degrees
Elevation Elevation angle returned in degrees
ERRVALUE RVC::SPOTOBJ::GetViewingDate ( DATETIME ViewDate  ) 

Get date and time of the scene acquisition.

RVC::SPOTOBJ& RVC::SPOTOBJ::operator= ( const RVC::SPOTOBJ rhs  ) 

Assignment.

Reimplemented from RVC::OBJECT.


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

Generated on Sun Oct 7 21:38:09 2012 for TNTsdk 2012 by  doxygen 1.6.1