ReFRACtor
FullPhysics::ObservationLevel1b Class Reference

#include <observation_level_1b.h>

+ Inheritance diagram for FullPhysics::ObservationLevel1b:
+ Collaboration diagram for FullPhysics::ObservationLevel1b:

Public Member Functions

 ObservationLevel1b (const boost::shared_ptr< Level1b > &level_1b, const boost::shared_ptr< Instrument > &instrument, const boost::shared_ptr< ForwardModelSpectralGrid > &spectral_grids)
 
int num_channels () const
 Number of spectral channels. More...
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 
Spectrum radiance (int channel_index, bool skip_jacobian=false) const
 Measured spectrum for the given spectral channel. More...
 
virtual Spectrum radiance_all (bool skip_jacobian=false) const
 Radiance data all stacked together as one long spectrum (so band 0, followed by band 1, etc.). More...
 
const SpectralDomain spectral_domain (int channel_index) const
 The spectral grid of the radiance values, implemented by inheriting class. More...
 
virtual const boost::optional< blitz::Range > stacked_pixel_range (int channel_index) const
 The range of indicies that corresponds to a particular band in the stacked radiances. More...
 

Detailed Description

Definition at line 11 of file observation_level_1b.h.

Constructor & Destructor Documentation

◆ ObservationLevel1b()

ObservationLevel1b::ObservationLevel1b ( const boost::shared_ptr< Level1b > &  level_1b,
const boost::shared_ptr< Instrument > &  instrument,
const boost::shared_ptr< ForwardModelSpectralGrid > &  spectral_grids 
)

Definition at line 15 of file observation_level_1b.cc.

Member Function Documentation

◆ num_channels()

int ObservationLevel1b::num_channels ( ) const
virtual

Number of spectral channels.

Implements FullPhysics::Observation.

Definition at line 22 of file observation_level_1b.cc.

◆ print()

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

Reimplemented from FullPhysics::Observation.

Definition at line 23 of file observation_level_1b.h.

◆ print_to_string()

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

◆ radiance()

Spectrum ObservationLevel1b::radiance ( int  channel_index,
bool  skip_jacobian = false 
) const
virtual

Measured spectrum for the given spectral channel.

Note that this may be empty.

Parameters
channel_indexBand to give value for
skip_jacobianIf true, don't do the Jacobian
Returns
The set of radiances, possibly empty.

Implements FullPhysics::Observation.

Definition at line 32 of file observation_level_1b.cc.

◆ radiance_all()

Spectrum StackedRadianceMixin::radiance_all ( bool  skip_jacobian = false) const
virtualinherited

Radiance data all stacked together as one long spectrum (so band 0, followed by band 1, etc.).

Definition at line 25 of file stacked_radiance_mixin.cc.

◆ spectral_domain()

const SpectralDomain ObservationLevel1b::spectral_domain ( int  channel_index) const
virtual

The spectral grid of the radiance values, implemented by inheriting class.

Implements FullPhysics::Observation.

Definition at line 27 of file observation_level_1b.cc.

◆ stacked_pixel_range()

const boost::optional< Range > StackedRadianceMixin::stacked_pixel_range ( int  channel_index) const
virtualinherited

The range of indicies that corresponds to a particular band in the stacked radiances.

The range may well be empty if a band is not used at all. This is a useful edge case, but unfortunately blitz::Range does not support empty ranges. As a simple work around, we use the boost::optional class to return a value only if the range is not empty.

Definition at line 6 of file stacked_radiance_mixin.cc.


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