ReFRACtor
FullPhysics::Level1bAverage Class Reference

This reads averages a set of Level1b classes to get the various values. More...

#include <level_1b_average.h>

+ Inheritance diagram for FullPhysics::Level1bAverage:
+ Collaboration diagram for FullPhysics::Level1bAverage:

Public Member Functions

 Level1bAverage (const std::vector< boost::shared_ptr< Level1b > > &Data)
 
virtual ~Level1bAverage ()
 
virtual DoubleWithUnit altitude (int i) const
 Altitude. More...
 
virtual DoubleWithUnit latitude (int i) const
 Latitude. More...
 
virtual DoubleWithUnit longitude (int i) const
 Longitude. More...
 
virtual int number_spectrometer () const
 Number of spectrometers. More...
 
virtual void print (std::ostream &Os) const
 Print description of object. More...
 
std::string print_to_string () const
 Print to string. More...
 
virtual SpectralRange radiance (int Spec_index) const
 Radiance, for given spectral band. More...
 
virtual DoubleWithUnit relative_azimuth (int i) const
 Realtive azimuth. More...
 
virtual DoubleWithUnit relative_velocity (int Spec_index) const
 Relative velocity. More...
 
virtual SpectralDomain sample_grid (int Spec_index) const
 Returns the sample grid (ie wavenumber, wavelength, etc) for the corresponding radiance values. More...
 
virtual DoubleWithUnit signal (int Spec_index, const std::vector< int > &Sample_indexes=std::vector< int >()) const
 Calculate an approximation to the size of the continuum signal where there is no significant atmosphere absorption. More...
 
virtual DoubleWithUnit solar_azimuth (int i) const
 Solar azimuth. More...
 
virtual DoubleWithUnit solar_zenith (int i) const
 Solar zenith. More...
 
virtual DoubleWithUnit sounding_azimuth (int i) const
 Sounding azimuth. More...
 
virtual DoubleWithUnit sounding_zenith (int i) const
 Sounding zenith. More...
 
virtual blitz::Array< double, 1 > stokes_coefficient (int i) const
 Return stokes coefficients. More...
 
virtual Time time (int Spec_index) const
 Time of sounding. More...
 

Detailed Description

This reads averages a set of Level1b classes to get the various values.

This is used for example on Gosat, where we average the S and P data.

Definition at line 14 of file level_1b_average.h.

Constructor & Destructor Documentation

◆ Level1bAverage()

FullPhysics::Level1bAverage::Level1bAverage ( const std::vector< boost::shared_ptr< Level1b > > &  Data)
inline

Definition at line 16 of file level_1b_average.h.

◆ ~Level1bAverage()

virtual FullPhysics::Level1bAverage::~Level1bAverage ( )
inlinevirtual

Definition at line 18 of file level_1b_average.h.

Member Function Documentation

◆ altitude()

DoubleWithUnit Level1bAverage::altitude ( int  i) const
virtual

Altitude.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Altitude

Implements FullPhysics::Level1b.

Definition at line 97 of file level_1b_average.cc.

◆ latitude()

DoubleWithUnit Level1bAverage::latitude ( int  i) const
virtual

Latitude.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Latitude.

Implements FullPhysics::Level1b.

Definition at line 39 of file level_1b_average.cc.

◆ longitude()

DoubleWithUnit Level1bAverage::longitude ( int  i) const
virtual

Longitude.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Longitude

Implements FullPhysics::Level1b.

Definition at line 47 of file level_1b_average.cc.

◆ number_spectrometer()

int Level1bAverage::number_spectrometer ( ) const
virtual

Number of spectrometers.

Implements FullPhysics::Level1b.

Definition at line 14 of file level_1b_average.cc.

◆ print()

void Level1bAverage::print ( std::ostream &  Os) const
virtual

Print description of object.

Reimplemented from FullPhysics::Level1b.

Definition at line 172 of file level_1b_average.cc.

◆ print_to_string()

std::string FullPhysics::Printable< Level1b >::print_to_string ( ) const
inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

◆ radiance()

SpectralRange Level1bAverage::radiance ( int  Spec_index) const
virtual

Radiance, for given spectral band.

This returns the radiance with associated units. It may or may not have a uncertainity with the radiance.

Implements FullPhysics::Level1b.

Definition at line 105 of file level_1b_average.cc.

◆ relative_azimuth()

virtual DoubleWithUnit FullPhysics::Level1b::relative_azimuth ( int  i) const
virtualinherited

Realtive azimuth.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Relative azimuth angle between solar and sounding azimuth

◆ relative_velocity()

DoubleWithUnit Level1bAverage::relative_velocity ( int  Spec_index) const
virtual

Relative velocity.

Returns
Relative velocity

Implements FullPhysics::Level1b.

Definition at line 20 of file level_1b_average.cc.

◆ sample_grid()

SpectralDomain Level1bAverage::sample_grid ( int  Spec_index) const
virtual

Returns the sample grid (ie wavenumber, wavelength, etc) for the corresponding radiance values.

The meaning of these coefficients will be specific to the instrument that measured the data.

Implements FullPhysics::Level1b.

Definition at line 33 of file level_1b_average.cc.

◆ signal()

virtual DoubleWithUnit FullPhysics::Level1b::signal ( int  Spec_index,
const std::vector< int > &  Sample_indexes = std::vector< int >() 
) const
virtualinherited

Calculate an approximation to the size of the continuum signal where there is no significant atmosphere absorption.

We approximate this by finding the 10 highest radiance values and averaging them.

Optionally takes a list of sample indexes. Will only uses these sample indexes for the calculation when supplied.

◆ solar_azimuth()

DoubleWithUnit Level1bAverage::solar_azimuth ( int  i) const
virtual

Solar azimuth.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Solar azimuth angle

Implements FullPhysics::Level1b.

Definition at line 89 of file level_1b_average.cc.

◆ solar_zenith()

DoubleWithUnit Level1bAverage::solar_zenith ( int  i) const
virtual

Solar zenith.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Solar zenith angle

Implements FullPhysics::Level1b.

Definition at line 81 of file level_1b_average.cc.

◆ sounding_azimuth()

DoubleWithUnit Level1bAverage::sounding_azimuth ( int  i) const
virtual

Sounding azimuth.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Sounding azimuth

Implements FullPhysics::Level1b.

Definition at line 63 of file level_1b_average.cc.

◆ sounding_zenith()

DoubleWithUnit Level1bAverage::sounding_zenith ( int  i) const
virtual

Sounding zenith.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Sounding zenith

Implements FullPhysics::Level1b.

Definition at line 55 of file level_1b_average.cc.

◆ stokes_coefficient()

Array< double, 1 > Level1bAverage::stokes_coefficient ( int  i) const
virtual

Return stokes coefficients.

Parameters
iSpectrometer index (between 0 and number_spectrometer() - 1)
Returns
Stokes coefficients, with size 4.

Implements FullPhysics::Level1b.

Definition at line 71 of file level_1b_average.cc.

◆ time()

Time Level1bAverage::time ( int  Spec_index) const
virtual

Time of sounding.

Implements FullPhysics::Level1b.

Definition at line 28 of file level_1b_average.cc.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:12