FullPhysics::NamedSpectrum Class Reference

Adds name and spec index fields to a Spectrum. More...

#include <named_spectrum.h>

Inheritance diagram for FullPhysics::NamedSpectrum:

Collaboration diagram for FullPhysics::NamedSpectrum:

Public Member Functions
	NamedSpectrum (const SpectralDomain &Spec_domain, const SpectralRange &Spec_range, const std::string &Name, int Index)
	Constructor. More...
	NamedSpectrum (const Spectrum &Spec, const std::string &Name, int Index)
	NamedSpectrum ()
	Default constructor needed for SWIG. More...
const Spectrum	clone () const
	Clones object into a new copy. More...
virtual int	index () const
	An reference index for the spectrum, ie a spectrometer index. More...
virtual const std::string &	name () const
	Name that makes this a named spectrum. More...
void	print (std::ostream &Os)
std::string	print_to_string () const
	Print to string. More...
const SpectralDomain &	spectral_domain () const
	Spectral domain (i.e., wavenumber or wavelength). More...
SpectralDomain &	spectral_domain ()
const SpectralRange &	spectral_range () const
	Spectral range (e.g, radiance values) More...
SpectralRange &	spectral_range ()

Detailed Description

Adds name and spec index fields to a Spectrum.

Useful for sending Spectrum files to output files.

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 15 of file named_spectrum.h.

Constructor & Destructor Documentation

NamedSpectrum() [1/3]

FullPhysics::NamedSpectrum::NamedSpectrum ( const SpectralDomain &  Spec_domain, const SpectralRange &  Spec_range, const std::string &  Name, int  Index  )

inline

Constructor.

Definition at line 21 of file named_spectrum.h.

NamedSpectrum() [2/3]

FullPhysics::NamedSpectrum::NamedSpectrum ( const Spectrum &  Spec, const std::string &  Name, int  Index  )

inline

Definition at line 26 of file named_spectrum.h.

NamedSpectrum() [3/3]

FullPhysics::NamedSpectrum::NamedSpectrum ( )

inline

Default constructor needed for SWIG.

Definition at line 50 of file named_spectrum.h.

Member Function Documentation

clone()

const Spectrum FullPhysics::Spectrum::clone ( ) const

inlineinherited

Clones object into a new copy.

Definition at line 46 of file spectrum.h.

index()

virtual int FullPhysics::NamedSpectrum::index ( ) const

inlinevirtual

An reference index for the spectrum, ie a spectrometer index.

Definition at line 40 of file named_spectrum.h.

name()

virtual const std::string& FullPhysics::NamedSpectrum::name ( ) const

inlinevirtual

Name that makes this a named spectrum.

Definition at line 34 of file named_spectrum.h.

print()

void FullPhysics::NamedSpectrum::print ( std::ostream &  Os )

inline

Definition at line 42 of file named_spectrum.h.

print_to_string()

std::string FullPhysics::Printable< Spectrum >::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_domain() [1/2]

const SpectralDomain& FullPhysics::Spectrum::spectral_domain ( ) const

inlineinherited

Spectral domain (i.e., wavenumber or wavelength).

Definition at line 32 of file spectrum.h.

spectral_domain() [2/2]

SpectralDomain& FullPhysics::Spectrum::spectral_domain ( )

inlineinherited

Definition at line 33 of file spectrum.h.

spectral_range() [1/2]

const SpectralRange& FullPhysics::Spectrum::spectral_range ( ) const

inlineinherited

Spectral range (e.g, radiance values)

Definition at line 39 of file spectrum.h.

spectral_range() [2/2]

SpectralRange& FullPhysics::Spectrum::spectral_range ( )

inlineinherited

Definition at line 40 of file spectrum.h.

---

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

• Support/named_spectrum.h