This is used to wrap the nominal Level 1B file reader. More...

#include <level_1b_sample_coefficient.h>

Inheritance diagram for FullPhysics::Level1bSampleCoefficient:

Collaboration diagram for FullPhysics::Level1bSampleCoefficient:

Public Member Functions
	Level1bSampleCoefficient (const bool One_based=true)

virtual	~Level1bSampleCoefficient ()

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
	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 ArrayWithUnit< double, 1 >	spectral_coefficient (int Spec_index) const =0
	Returns coefficients for an equation describing the special domain used to translate radiance value indexes to their corresponding spectral grid. 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 wrap the nominal Level 1B file reader.

It creates the required SpectralDomain from the given coefficients. It calculautes the wavelength/wavenumber as follows: f(x) = x*(coeff[0]^0) + x*(coeff[1]^1) ... + x*(coeff[n]^n) Where n is spectral_coefficient length.

one_based_ describes whether the first index at which the polynomial is evaluted is index 0 or 1 (one-based).

Definition at line 23 of file level_1b_sample_coefficient.h.

Constructor & Destructor Documentation

◆ Level1bSampleCoefficient()

FullPhysics::Level1bSampleCoefficient::Level1bSampleCoefficient ( const bool One_based = true )

inline

Definition at line 25 of file level_1b_sample_coefficient.h.

◆ ~Level1bSampleCoefficient()

virtual FullPhysics::Level1bSampleCoefficient::~Level1bSampleCoefficient ( )

inlinevirtual

Definition at line 26 of file level_1b_sample_coefficient.h.

Member Function Documentation

◆ altitude()

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

pure virtualinherited

Altitude.

Parameters

i	Spectrometer index (between 0 and number_spectrometer() - 1)

Returns: Altitude

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

◆ latitude()

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

pure virtualinherited

Latitude.

Parameters

i	Spectrometer 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 virtualinherited

Longitude.

Parameters

i	Spectrometer 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 virtualinherited

Number of spectrometers.

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

◆ print()

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

inlinevirtual

Print description of object.

Reimplemented from FullPhysics::Level1b.

Reimplemented in FullPhysics::ExampleLevel1b.

Definition at line 51 of file level_1b_sample_coefficient.h.

◆ 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 virtualinherited

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

virtualinherited

Realtive azimuth.

Parameters

i	Spectrometer 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 virtualinherited

Relative velocity.

Returns: Relative velocity

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

◆ sample_grid()

SpectralDomain Level1bSampleCoefficient::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 57 of file level_1b_sample_coefficient.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()

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

pure virtualinherited

Solar azimuth.

Parameters

i	Spectrometer 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 virtualinherited

Solar zenith.

Parameters

i	Spectrometer 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 virtualinherited

Sounding azimuth.

Parameters

i	Spectrometer 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 virtualinherited

Sounding zenith.

Parameters

i	Spectrometer index (between 0 and number_spectrometer() - 1)

Returns: Sounding zenith

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

◆ spectral_coefficient()

virtual ArrayWithUnit<double, 1> FullPhysics::Level1bSampleCoefficient::spectral_coefficient ( int Spec_index ) const

pure virtual

Returns coefficients for an equation describing the special domain used to translate radiance value indexes to their corresponding spectral grid.

(ie wavenumber, wavelength, etc) The meaning of these coefficients will be specific to the instrument that measured the data.

Implemented in FullPhysics::ExampleLevel1b.

◆ stokes_coefficient()

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

pure virtualinherited

Return stokes coefficients.

Parameters

i	Spectrometer 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 virtualinherited

Time of sounding.

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

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

Interface/level_1b_sample_coefficient.h
Interface/level_1b_sample_coefficient.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Level1bSampleCoefficient()

◆ ~Level1bSampleCoefficient()

Member Function Documentation

◆ altitude()

◆ latitude()

◆ longitude()

◆ number_spectrometer()

◆ print()

◆ print_to_string()

◆ radiance()

◆ relative_azimuth()

◆ relative_velocity()

◆ sample_grid()

◆ signal()

◆ solar_azimuth()

◆ solar_zenith()

◆ sounding_azimuth()

◆ sounding_zenith()

◆ spectral_coefficient()

◆ stokes_coefficient()

◆ time()