ReFRACtor
FullPhysics::Spectrum Class Reference

This is a full spectrum, which contains a SpectralRange and SpectralDomain. More...

#include <spectrum.h>

+ Inheritance diagram for FullPhysics::Spectrum:
+ Collaboration diagram for FullPhysics::Spectrum:

Public Member Functions

 Spectrum (const SpectralDomain &Spec_domain, const SpectralRange &Spec_range)
 Constructor. More...
 
 Spectrum ()
 Default constructor needed for SWIG. More...
 
virtual ~Spectrum ()
 
const Spectrum clone () const
 Clones object into a new copy. More...
 
void print (std::ostream &Os)
 
std::string print_to_string () const
 Print to string. More...
 
const SpectralDomainspectral_domain () const
 Spectral domain (i.e., wavenumber or wavelength). More...
 
SpectralDomainspectral_domain ()
 
const SpectralRangespectral_range () const
 Spectral range (e.g, radiance values) More...
 
SpectralRangespectral_range ()
 

Detailed Description

This is a full spectrum, which contains a SpectralRange and SpectralDomain.

The SpectralRange has a value, possibly with associated Jacobian and/or uncertainty, and units. The SpectralDomain has the wavenumber/wavelength of the spectrum.

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 18 of file spectrum.h.

Constructor & Destructor Documentation

◆ Spectrum() [1/2]

FullPhysics::Spectrum::Spectrum ( const SpectralDomain Spec_domain,
const SpectralRange Spec_range 
)
inline

Constructor.

Definition at line 24 of file spectrum.h.

◆ Spectrum() [2/2]

FullPhysics::Spectrum::Spectrum ( )
inline

Default constructor needed for SWIG.

Definition at line 51 of file spectrum.h.

◆ ~Spectrum()

virtual FullPhysics::Spectrum::~Spectrum ( )
inlinevirtual

Definition at line 53 of file spectrum.h.

Member Function Documentation

◆ clone()

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

Clones object into a new copy.

Definition at line 46 of file spectrum.h.

◆ print()

void FullPhysics::Spectrum::print ( std::ostream &  Os)
inline

Definition at line 48 of file 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
inline

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

Definition at line 32 of file spectrum.h.

◆ spectral_domain() [2/2]

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

Definition at line 33 of file spectrum.h.

◆ spectral_range() [1/2]

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

Spectral range (e.g, radiance values)

Definition at line 39 of file spectrum.h.

◆ spectral_range() [2/2]

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

Definition at line 40 of file spectrum.h.


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:13