FullPhysics::Observation Class Reference

#include <observation.h>

Inheritance diagram for FullPhysics::Observation:

Collaboration diagram for FullPhysics::Observation:

Public Member Functions
virtual int	num_channels () const =0
	Number of spectral channels. More...
virtual void	print (std::ostream &Os) const
std::string	print_to_string () const
	Print to string. More...
virtual Spectrum	radiance (int channel_index, bool skip_jacobian=false) const =0
	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...
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 9 of file observation.h.

Member Function Documentation

num_channels()

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

pure virtual

Number of spectral channels.

Implements FullPhysics::StackedRadianceMixin.

Implemented in FullPhysics::ObservationLevel1b.

print()

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

inlinevirtual

Reimplemented in FullPhysics::ObservationLevel1b.

Definition at line 24 of file observation.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()

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

pure virtual

Measured spectrum for the given spectral channel.

Note that this may be empty.

Parameters

channel_index	Band to give value for
skip_jacobian	If true, don't do the Jacobian

Returns

The set of radiances, possibly empty.

Implements FullPhysics::StackedRadianceMixin.

Implemented in FullPhysics::ObservationLevel1b.

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

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

pure virtual

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

Implements FullPhysics::StackedRadianceMixin.

Implemented in FullPhysics::ObservationLevel1b.

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 file:

• Interface/observation.h