ReFRACtor
FullPhysics::SolarDopplerShift Class Referenceabstract

This class handles the solar Doppler stretch to calculate the shift of the solar lines with respect to the telluric lines. More...

#include <solar_doppler_shift.h>

+ Inheritance diagram for FullPhysics::SolarDopplerShift:
+ Collaboration diagram for FullPhysics::SolarDopplerShift:

Public Member Functions

virtual ~SolarDopplerShift ()
 
virtual SpectralDomain doppler_stretch (const SpectralDomain &Spec_domain) const =0
 Shift wavenumbers to account for doppler stretch. More...
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 
virtual DoubleWithUnit solar_distance () const =0
 Return Earth-Sun distance. More...
 

Detailed Description

This class handles the solar Doppler stretch to calculate the shift of the solar lines with respect to the telluric lines.

Definition at line 13 of file solar_doppler_shift.h.

Constructor & Destructor Documentation

◆ ~SolarDopplerShift()

virtual FullPhysics::SolarDopplerShift::~SolarDopplerShift ( )
inlinevirtual

Definition at line 15 of file solar_doppler_shift.h.

Member Function Documentation

◆ doppler_stretch()

virtual SpectralDomain FullPhysics::SolarDopplerShift::doppler_stretch ( const SpectralDomain Spec_domain) const
pure virtual

Shift wavenumbers to account for doppler stretch.

Parameters
Spec_domainwavenumber/wavelength
Returns
Wavenumber/wavelength with Doppler stretch.

Implemented in FullPhysics::SolarDopplerShiftPolynomial, and FullPhysics::SolarDopplerShiftL1b.

◆ print()

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

◆ print_to_string()

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

◆ solar_distance()

virtual DoubleWithUnit FullPhysics::SolarDopplerShift::solar_distance ( ) const
pure virtual

Return Earth-Sun distance.

Returns
Earth-Sun distance.

Implemented in FullPhysics::SolarDopplerShiftPolynomial, and FullPhysics::SolarDopplerShiftL1b.


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