ReFRACtor
FullPhysics::SolarDopplerShiftL1b Class Reference

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_l1b.h>

+ Inheritance diagram for FullPhysics::SolarDopplerShiftL1b:
+ Collaboration diagram for FullPhysics::SolarDopplerShiftL1b:

Public Member Functions

 SolarDopplerShiftL1b (const DoubleWithUnit &Solar_distance, const DoubleWithUnit &Solar_relative_velocity, bool Apply_doppler_shift=true)
 Create a SolarDopplerShiftL1b. More...
 
virtual ~SolarDopplerShiftL1b ()
 
double doppler_shift () const
 
virtual SpectralDomain doppler_stretch (const SpectralDomain &Spec_domain) const
 Shift wavenumbers to account for doppler stretch. More...
 
virtual void print (std::ostream &Os) const
 Print description of object. More...
 
std::string print_to_string () const
 Print to string. More...
 
virtual DoubleWithUnit solar_distance () const
 Return Earth-Sun distance. More...
 
DoubleWithUnit solar_relative_velocity () const
 Velocity of the sounding to the center of the sun. More...
 

Detailed Description

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

This implementation gets the Level 1b solar velocity and solar distance passed to it.

Definition at line 17 of file solar_doppler_shift_l1b.h.

Constructor & Destructor Documentation

◆ SolarDopplerShiftL1b()

SolarDopplerShiftL1b::SolarDopplerShiftL1b ( const DoubleWithUnit Solar_distance,
const DoubleWithUnit Solar_relative_velocity,
bool  Apply_doppler_shift = true 
)

Create a SolarDopplerShiftL1b.

Parameters
Solar_distanceThe distance between observed surface and sun
Solar_relative_velocityThe velocity of the sun along the observed sounding location/sun vector. This includes the rotation of the earth. Positive indicates the sun is moving away from the point.
Apply_doppler_shiftIndicates if we should apply the doppler shift or not. If this is false, then we just pass the wave numbers through unchanged in doppler_stretch.

Definition at line 25 of file solar_doppler_shift_l1b.cc.

◆ ~SolarDopplerShiftL1b()

virtual FullPhysics::SolarDopplerShiftL1b::~SolarDopplerShiftL1b ( )
inlinevirtual

Definition at line 23 of file solar_doppler_shift_l1b.h.

Member Function Documentation

◆ doppler_shift()

double FullPhysics::SolarDopplerShiftL1b::doppler_shift ( ) const
inline

Definition at line 44 of file solar_doppler_shift_l1b.h.

◆ doppler_stretch()

SpectralDomain SolarDopplerShiftL1b::doppler_stretch ( const SpectralDomain Spec_domain) const
virtual

Shift wavenumbers to account for doppler stretch.

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

Implements FullPhysics::SolarDopplerShift.

Definition at line 51 of file solar_doppler_shift_l1b.cc.

◆ print()

void SolarDopplerShiftL1b::print ( std::ostream &  Os) const
virtual

Print description of object.

Reimplemented from FullPhysics::SolarDopplerShift.

Definition at line 42 of file solar_doppler_shift_l1b.cc.

◆ 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::SolarDopplerShiftL1b::solar_distance ( ) const
inlinevirtual

Return Earth-Sun distance.

Returns
Earth-Sun distance.

Implements FullPhysics::SolarDopplerShift.

Definition at line 30 of file solar_doppler_shift_l1b.h.

◆ solar_relative_velocity()

DoubleWithUnit FullPhysics::SolarDopplerShiftL1b::solar_relative_velocity ( ) const
inline

Velocity of the sounding to the center of the sun.

Positive means they are getting farther apart. This does include the rotation of the earth (cf solar_velocity in SolarDopplerShiftPolynomial which does not include rotation of earth)

Definition at line 41 of file solar_doppler_shift_l1b.h.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:13