ReFRACtor
FullPhysics::Level1b Class Referenceabstract

This is used to read a Level 1B file. More...

#include <level_1b.h>

+ Inheritance diagram for FullPhysics::Level1b:
+ Collaboration diagram for FullPhysics::Level1b:

Public Member Functions

virtual ~Level1b ()
 
virtual DoubleWithUnit altitude (int i) const =0
 Altitude. More...
 
virtual DoubleWithUnit latitude (int i) const =0
 Latitude. More...
 
virtual DoubleWithUnit longitude (int i) const =0
 Longitude. More...
 
virtual int number_spectrometer () const =0
 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 =0
 Radiance, for given spectral band. More...
 
virtual DoubleWithUnit relative_azimuth (int i) const
 Realtive azimuth. More...
 
virtual DoubleWithUnit relative_velocity (int Spec_index) const =0
 Relative velocity. More...
 
virtual SpectralDomain sample_grid (int Spec_index) const =0
 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 =0
 Solar azimuth. More...
 
virtual DoubleWithUnit solar_zenith (int i) const =0
 Solar zenith. More...
 
virtual DoubleWithUnit sounding_azimuth (int i) const =0
 Sounding azimuth. More...
 
virtual DoubleWithUnit sounding_zenith (int i) const =0
 Sounding zenith. More...
 
virtual blitz::Array< double, 1 > stokes_coefficient (int i) const =0
 Return stokes coefficients. More...
 
virtual Time time (int Spec_index) const =0
 Time of sounding. More...
 

Detailed Description

This is used to read a Level 1B file.

Definition at line 15 of file level_1b.h.

Constructor & Destructor Documentation

◆ ~Level1b()

virtual FullPhysics::Level1b::~Level1b ( )
inlinevirtual

Definition at line 17 of file level_1b.h.

Member Function Documentation

◆ altitude()

virtual DoubleWithUnit FullPhysics::Level1b::altitude ( int  i) const
pure virtual

◆ latitude()

virtual DoubleWithUnit FullPhysics::Level1b::latitude ( int  i) const
pure virtual

Latitude.

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

Implemented in FullPhysics::Level1bScaleRadiance, FullPhysics::ExampleLevel1b, FullPhysics::Level1bAverage, and FullPhysics::Level1bCache.

◆ longitude()

virtual DoubleWithUnit FullPhysics::Level1b::longitude ( int  i) const
pure virtual

Longitude.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::Level1bScaleRadiance, FullPhysics::ExampleLevel1b, and FullPhysics::Level1bAverage.

◆ number_spectrometer()

virtual int FullPhysics::Level1b::number_spectrometer ( ) const
pure virtual

◆ print()

virtual void FullPhysics::Level1b::print ( std::ostream &  Os) const
inlinevirtual

◆ 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()

virtual SpectralRange FullPhysics::Level1b::radiance ( int  Spec_index) const
pure virtual

Radiance, for given spectral band.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::ExampleLevel1b, FullPhysics::Level1bScaleRadiance, and FullPhysics::Level1bAverage.

◆ relative_azimuth()

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

Realtive azimuth.

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

◆ relative_velocity()

virtual DoubleWithUnit FullPhysics::Level1b::relative_velocity ( int  Spec_index) const
pure virtual

◆ sample_grid()

virtual SpectralDomain FullPhysics::Level1b::sample_grid ( int  Spec_index) const
pure 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.

Implemented in FullPhysics::Level1bCache, FullPhysics::Level1bScaleRadiance, FullPhysics::Level1bSampleCoefficient, and FullPhysics::Level1bAverage.

◆ signal()

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

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()

virtual DoubleWithUnit FullPhysics::Level1b::solar_azimuth ( int  i) const
pure virtual

Solar azimuth.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::Level1bScaleRadiance, FullPhysics::ExampleLevel1b, and FullPhysics::Level1bAverage.

◆ solar_zenith()

virtual DoubleWithUnit FullPhysics::Level1b::solar_zenith ( int  i) const
pure virtual

Solar zenith.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::Level1bScaleRadiance, FullPhysics::ExampleLevel1b, and FullPhysics::Level1bAverage.

◆ sounding_azimuth()

virtual DoubleWithUnit FullPhysics::Level1b::sounding_azimuth ( int  i) const
pure virtual

Sounding azimuth.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::ExampleLevel1b, FullPhysics::Level1bScaleRadiance, and FullPhysics::Level1bAverage.

◆ sounding_zenith()

virtual DoubleWithUnit FullPhysics::Level1b::sounding_zenith ( int  i) const
pure virtual

Sounding zenith.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::ExampleLevel1b, FullPhysics::Level1bScaleRadiance, and FullPhysics::Level1bAverage.

◆ stokes_coefficient()

virtual blitz::Array<double, 1> FullPhysics::Level1b::stokes_coefficient ( int  i) const
pure virtual

Return stokes coefficients.

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

Implemented in FullPhysics::Level1bCache, FullPhysics::ExampleLevel1b, FullPhysics::Level1bScaleRadiance, and FullPhysics::Level1bAverage.

◆ time()

virtual Time FullPhysics::Level1b::time ( int  Spec_index) const
pure virtual

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

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