FullPhysics::SpectralWindow Class Reference

This class represents a the spectral window. More...

#include <spectral_window.h>

Inheritance diagram for FullPhysics::SpectralWindow:

Collaboration diagram for FullPhysics::SpectralWindow:

Public Member Functions
virtual	~SpectralWindow ()
SpectralDomain	apply (const SpectralDomain &Grid, int Spec_index) const
	Apply a spectral window to a SpectralDomain, returning the possibly empty part of the domain that passes through the window. More...
Spectrum	apply (const Spectrum &Spec, int Spec_index) const
	Apply a spectral window to a Spectrum, returning the possibly empty part of the spectrum that passes through the window. More...
virtual std::vector< int >	grid_indexes (const SpectralDomain &Grid, int Spec_index) const =0
	Given a list of wavenumbers, this returns the indices that fall within the window. More...
virtual int	number_spectrometer () const =0
	Number of spectrometers. More...
virtual void	print (std::ostream &Os) const
std::string	print_to_string () const
	Print to string. More...
virtual SpectralBound	spectral_bound () const =0
	Bounds of spectral window. More...

Detailed Description

This class represents a the spectral window.

The definition of a spectral window is purposely fuzzy, we want to support things like excluding certain wavenumbers. So the interface simple takes a list of potential wavenumbers (e.g., the wavenumbers measured to the GOSAT oxygen A spectrometer) and returns the list of values that fall within the window. For example, if the window is just a wavenumber range, then all the wavenumbers that fall within that range are returned.

Note that there are a few closely related classes, with similar sounding names. See Spectrum related classes for a description of each of these.

Definition at line 27 of file spectral_window.h.

Constructor & Destructor Documentation

~SpectralWindow()

virtual FullPhysics::SpectralWindow::~SpectralWindow ( )

inlinevirtual

Definition at line 29 of file spectral_window.h.

Member Function Documentation

apply() [1/2]

SpectralDomain SpectralWindow::apply	(	const SpectralDomain &	Grid,
		int	Spec_index
	)		const

Apply a spectral window to a SpectralDomain, returning the possibly empty part of the domain that passes through the window.

Definition at line 20 of file spectral_window.cc.

apply() [2/2]

Spectrum SpectralWindow::apply	(	const Spectrum &	Spec,
		int	Spec_index
	)		const

Apply a spectral window to a Spectrum, returning the possibly empty part of the spectrum that passes through the window.

Definition at line 41 of file spectral_window.cc.

grid_indexes()

virtual std::vector<int> FullPhysics::SpectralWindow::grid_indexes ( const SpectralDomain &  Grid, int  Spec_index  ) const

pure virtual

Given a list of wavenumbers, this returns the indices that fall within the window.

Implemented in FullPhysics::SpectralWindowRange.

number_spectrometer()

virtual int FullPhysics::SpectralWindow::number_spectrometer ( ) const

pure virtual

Number of spectrometers.

Implemented in FullPhysics::SpectralWindowRange.

print()

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

inlinevirtual

Reimplemented in FullPhysics::SpectralWindowRange.

Definition at line 54 of file spectral_window.h.

print_to_string()

std::string FullPhysics::Printable< SpectralWindow >::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.

spectral_bound()

virtual SpectralBound FullPhysics::SpectralWindow::spectral_bound ( ) const

pure virtual

Bounds of spectral window.

Implemented in FullPhysics::SpectralWindowRange.

---

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

• Interface/spectral_window.h
• Interface/spectral_window.cc