This is an example L1B reader that reads a HDF formatted file that corresponds one-to-one with the expected interface. More...

#include <example_level_1b.h>

Inheritance diagram for FullPhysics::ExampleLevel1b:

Collaboration diagram for FullPhysics::ExampleLevel1b:

Public Member Functions
	ExampleLevel1b (const boost::shared_ptr< HdfFile > &input_file, const std::string &observation_id)

	ExampleLevel1b (const std::string &input_filename, const std::string &observation_id)

virtual	~ExampleLevel1b ()

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 i) 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 ArrayWithUnit< double, 1 >	spectral_coefficient (int i) const
	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
	Return stokes coefficients. More...

virtual Time	time (int i) const
	Time of sounding. More...

Detailed Description

This is an example L1B reader that reads a HDF formatted file that corresponds one-to-one with the expected interface.

Definition at line 16 of file example_level_1b.h.

Constructor & Destructor Documentation

◆ ExampleLevel1b() [1/2]

ExampleLevel1b::ExampleLevel1b	(	const boost::shared_ptr< HdfFile > &	input_file,
		const std::string &	observation_id
	)

Definition at line 17 of file example_level_1b.cc.

◆ ExampleLevel1b() [2/2]

ExampleLevel1b::ExampleLevel1b	(	const std::string &	input_filename,
		const std::string &	observation_id
	)

Definition at line 25 of file example_level_1b.cc.

◆ ~ExampleLevel1b()

virtual FullPhysics::ExampleLevel1b::~ExampleLevel1b ( )

inlinevirtual

Definition at line 20 of file example_level_1b.h.

Member Function Documentation

◆ altitude()

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

inlinevirtual

Altitude.

Parameters

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

Returns: Altitude

Implements FullPhysics::Level1b.

Definition at line 36 of file example_level_1b.h.

◆ latitude()

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

inlinevirtual

Latitude.

Parameters

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

Returns: Latitude.

Implements FullPhysics::Level1b.

Definition at line 24 of file example_level_1b.h.

◆ longitude()

virtual DoubleWithUnit FullPhysics::ExampleLevel1b::longitude ( int i ) const

inlinevirtual

Longitude.

Parameters

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

Returns: Longitude

Implements FullPhysics::Level1b.

Definition at line 27 of file example_level_1b.h.

◆ number_spectrometer()

int ExampleLevel1b::number_spectrometer ( ) const

virtual

Number of spectrometers.

Implements FullPhysics::Level1b.

Definition at line 33 of file example_level_1b.cc.

◆ print()

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

inlinevirtual

Print description of object.

Reimplemented from FullPhysics::Level1bSampleCoefficient.

Definition at line 57 of file example_level_1b.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()

SpectralRange ExampleLevel1b::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 39 of file example_level_1b.cc.

◆ 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::ExampleLevel1b::relative_velocity ( int Spec_index ) const

inlinevirtual

Relative velocity.

Returns: Relative velocity

Implements FullPhysics::Level1b.

Definition at line 48 of file example_level_1b.h.

◆ sample_grid()

SpectralDomain Level1bSampleCoefficient::sample_grid ( int Spec_index ) const

virtualinherited

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::ExampleLevel1b::solar_azimuth ( int i ) const

inlinevirtual

Solar azimuth.

Parameters

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

Returns: Solar azimuth angle

Implements FullPhysics::Level1b.

Definition at line 33 of file example_level_1b.h.

◆ solar_zenith()

virtual DoubleWithUnit FullPhysics::ExampleLevel1b::solar_zenith ( int i ) const

inlinevirtual

Solar zenith.

Parameters

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

Returns: Solar zenith angle

Implements FullPhysics::Level1b.

Definition at line 30 of file example_level_1b.h.

◆ sounding_azimuth()

virtual DoubleWithUnit FullPhysics::ExampleLevel1b::sounding_azimuth ( int i ) const

inlinevirtual

Sounding azimuth.

Parameters

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

Returns: Sounding azimuth

Implements FullPhysics::Level1b.

Definition at line 42 of file example_level_1b.h.

◆ sounding_zenith()

virtual DoubleWithUnit FullPhysics::ExampleLevel1b::sounding_zenith ( int i ) const

inlinevirtual

Sounding zenith.

Parameters

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

Returns: Sounding zenith

Implements FullPhysics::Level1b.

Definition at line 39 of file example_level_1b.h.

◆ spectral_coefficient()

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

inlinevirtual

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.

Implements FullPhysics::Level1bSampleCoefficient.

Definition at line 51 of file example_level_1b.h.

◆ stokes_coefficient()

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

inlinevirtual

Return stokes coefficients.

Parameters

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

Returns: Stokes coefficients, with size 4.

Implements FullPhysics::Level1b.

Definition at line 45 of file example_level_1b.h.

◆ time()

virtual Time FullPhysics::ExampleLevel1b::time ( int Spec_index ) const

inlinevirtual

Time of sounding.

Implements FullPhysics::Level1b.

Definition at line 54 of file example_level_1b.h.

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

Example/example_level_1b.h
Example/example_level_1b.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ExampleLevel1b() [1/2]

◆ ExampleLevel1b() [2/2]

◆ ~ExampleLevel1b()

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