FullPhysics::AtmRefractiveIndex Class Reference

This class provides an interface for classes that compute a refractive index for an atmosphere at a given level or layer. More...

#include <refractive_index.h>

Inheritance diagram for FullPhysics::AtmRefractiveIndex:

Collaboration diagram for FullPhysics::AtmRefractiveIndex:

Public Member Functions
virtual	~AtmRefractiveIndex ()
virtual AutoDerivative< double >	at_layer (int layer_index, const AutoDerivative< double > &interp_val) const =0
	Returns refractive index at a layer index interpolated between bounding levels using a linear interpolation factor [0,1]. More...
virtual AutoDerivative< double >	at_layer_midpoint (int layer_index) const
	Convenience routine to returns refractive index ay layer index where layer data is taken as mean of bounding level values. More...
virtual AutoDerivative< double >	at_level (int level_index) const =0
	Returns refractive index at a level index. More...
virtual blitz::Array< AutoDerivative< double >, 1 >	layer_midpoint_values () const
	Returns refractive index at the middle of each layer. More...
virtual blitz::Array< AutoDerivative< double >, 1 >	layer_values (const blitz::Array< AutoDerivative< double >, 1 > &interp_vals) const
	Returns refractive index at all layers according to a mapping of where each layer value should be calculated between levels. More...
virtual blitz::Array< AutoDerivative< double >, 1 >	level_values () const
	Returns refractive index at all levels. More...
virtual int	number_layer () const
	Number of layers of atmospheric data represented. More...
virtual int	number_level () const =0
	Number of levels of atmospheric data represented. More...

Detailed Description

This class provides an interface for classes that compute a refractive index for an atmosphere at a given level or layer.

Definition at line 22 of file refractive_index.h.

Constructor & Destructor Documentation

~AtmRefractiveIndex()

virtual FullPhysics::AtmRefractiveIndex::~AtmRefractiveIndex ( )

inlinevirtual

Definition at line 26 of file refractive_index.h.

Member Function Documentation

at_layer()

virtual AutoDerivative<double> FullPhysics::AtmRefractiveIndex::at_layer ( int  layer_index, const AutoDerivative< double > &  interp_val  ) const

pure virtual

Returns refractive index at a layer index interpolated between bounding levels using a linear interpolation factor [0,1].

Implemented in FullPhysics::OcoRefractiveIndex, and FullPhysics::SimpleRefractiveIndex.

at_layer_midpoint()

virtual AutoDerivative<double> FullPhysics::AtmRefractiveIndex::at_layer_midpoint ( int  layer_index ) const

inlinevirtual

Convenience routine to returns refractive index ay layer index where layer data is taken as mean of bounding level values.

Definition at line 74 of file refractive_index.h.

at_level()

virtual AutoDerivative<double> FullPhysics::AtmRefractiveIndex::at_level ( int  level_index ) const

pure virtual

Returns refractive index at a level index.

Implemented in FullPhysics::OcoRefractiveIndex, and FullPhysics::SimpleRefractiveIndex.

layer_midpoint_values()

virtual blitz::Array<AutoDerivative<double>, 1> FullPhysics::AtmRefractiveIndex::layer_midpoint_values ( ) const

inlinevirtual

Returns refractive index at the middle of each layer.

Definition at line 81 of file refractive_index.h.

layer_values()

virtual blitz::Array<AutoDerivative<double>, 1> FullPhysics::AtmRefractiveIndex::layer_values ( const blitz::Array< AutoDerivative< double >, 1 > &  interp_vals ) const

inlinevirtual

Returns refractive index at all layers according to a mapping of where each layer value should be calculated between levels.

Definition at line 62 of file refractive_index.h.

level_values()

virtual blitz::Array<AutoDerivative<double>, 1> FullPhysics::AtmRefractiveIndex::level_values ( ) const

inlinevirtual

Returns refractive index at all levels.

Definition at line 45 of file refractive_index.h.

number_layer()

virtual int FullPhysics::AtmRefractiveIndex::number_layer ( ) const

inlinevirtual

Number of layers of atmospheric data represented.

Definition at line 35 of file refractive_index.h.

number_level()

virtual int FullPhysics::AtmRefractiveIndex::number_level ( ) const

pure virtual

Number of levels of atmospheric data represented.

Implemented in FullPhysics::OcoRefractiveIndex, and FullPhysics::SimpleRefractiveIndex.

---

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

• Implementation/refractive_index.h