FullPhysics::StackedRadianceMixin Class Reference

#include <stacked_radiance_mixin.h>

Inheritance diagram for FullPhysics::StackedRadianceMixin:

Collaboration diagram for FullPhysics::StackedRadianceMixin:

Public Member Functions
virtual int	num_channels () const =0
	Number of spectral channels. More...
virtual Spectrum	radiance (int channel_index, bool skip_jacobian=false) const =0
	Per channel radiance data, implemented by inheriting class. 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...
virtual const SpectralDomain	spectral_domain (int channel_index) const =0
	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 stacked_radiance_mixin.h.

Member Function Documentation

num_channels()

virtual int FullPhysics::StackedRadianceMixin::num_channels ( ) const

pure virtual

Number of spectral channels.

Implemented in FullPhysics::StandardForwardModel, FullPhysics::FdForwardModel, FullPhysics::ForwardModel, FullPhysics::ObservationLevel1b, and FullPhysics::Observation.

radiance()

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

pure virtual

Per channel radiance data, implemented by inheriting class.

Implemented in FullPhysics::StandardForwardModel, FullPhysics::ForwardModel, FullPhysics::FdForwardModel, FullPhysics::Observation, and FullPhysics::ObservationLevel1b.

radiance_all()

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

virtual

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()

virtual const SpectralDomain FullPhysics::StackedRadianceMixin::spectral_domain ( int  channel_index ) const

pure virtual

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

Implemented in FullPhysics::StandardForwardModel, FullPhysics::ForwardModel, FullPhysics::FdForwardModel, FullPhysics::ObservationLevel1b, and FullPhysics::Observation.

stacked_pixel_range()

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

virtual

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:

• Support/stacked_radiance_mixin.h
• Support/stacked_radiance_mixin.cc