Isis 3 Programmer Reference
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
Isis::SpectralDefinition Class Referenceabstract

contains calibration info for spectral smile correction (center wavelengths and widths for the whole nxn chip) More...

#include <SpectralDefinition.h>

Inheritance diagram for Isis::SpectralDefinition:
Inheritance graph
Collaboration diagram for Isis::SpectralDefinition:
Collaboration graph

Public Member Functions

 SpectralDefinition ()
 Constructs an empty SpectralDefinition object.
 
virtual ~SpectralDefinition ()
 default destructor
 
virtual Spectel findSpectel (const int sample, const int line, const int band) const =0
 
virtual Spectel findSpectel (const Spectel &inSpectel, int sectionNumber) const =0
 
virtual Spectel findSpectelByWavelength (const double wavlength, int sectionNumber) const =0
 
virtual int sampleCount () const
 Returns the number of samples in the calibration image.
 
virtual int lineCount () const
 Returns the number of line in the calibration image.
 
virtual int bandCount () const
 Returns the number of bands in the calibration image.
 
virtual int sectionCount () const
 Returns the number of sections in the calibration image.
 
virtual int sectionNumber (int s, int l, int b) const =0
 

Protected Attributes

int m_ns
 Number of samples in input Cube.
 
int m_nl
 Number of lines in input Cube.
 
int m_nb
 Number of bands in input Cube.
 
int m_numSections
 Number of sections of the chip/wavelength data.
 

Private Member Functions

void init ()
 Constructor initializer.
 

Detailed Description

contains calibration info for spectral smile correction (center wavelengths and widths for the whole nxn chip)

Right now doens't do any calculations; just organizes contents of input and output smile definitions.

Author
2015-05-11 Kristin Berry
History

2015-06-09 Stuart Sides - Made pure virtual and added constness

2015-08-09 Kristin Berry - Moved implemention of getters to cpp.

Definition at line 34 of file SpectralDefinition.h.

Constructor & Destructor Documentation

◆ SpectralDefinition()

Isis::SpectralDefinition::SpectralDefinition ( )

Constructs an empty SpectralDefinition object.

Definition at line 21 of file SpectralDefinition.cpp.

References init().

◆ ~SpectralDefinition()

Isis::SpectralDefinition::~SpectralDefinition ( )
virtual

default destructor

Definition at line 27 of file SpectralDefinition.cpp.

Member Function Documentation

◆ bandCount()

int Isis::SpectralDefinition::bandCount ( ) const
virtual

Returns the number of bands in the calibration image.

Definition at line 50 of file SpectralDefinition.cpp.

References m_nb.

◆ findSpectel() [1/2]

virtual Spectel Isis::SpectralDefinition::findSpectel ( const int sample,
const int line,
const int band ) const
pure virtual

Implemented in Isis::SpectralDefinition1D, and Isis::SpectralDefinition2D.

◆ findSpectel() [2/2]

virtual Spectel Isis::SpectralDefinition::findSpectel ( const Spectel & inSpectel,
int sectionNumber ) const
pure virtual

Implemented in Isis::SpectralDefinition1D.

◆ findSpectelByWavelength()

virtual Spectel Isis::SpectralDefinition::findSpectelByWavelength ( const double wavlength,
int sectionNumber ) const
pure virtual

Implemented in Isis::SpectralDefinition1D.

◆ init()

void Isis::SpectralDefinition::init ( )
private

Constructor initializer.

Definition at line 65 of file SpectralDefinition.cpp.

References m_nb, m_nl, m_ns, and m_numSections.

Referenced by SpectralDefinition().

◆ lineCount()

int Isis::SpectralDefinition::lineCount ( ) const
virtual

Returns the number of line in the calibration image.

Definition at line 42 of file SpectralDefinition.cpp.

References m_nl.

◆ sampleCount()

int Isis::SpectralDefinition::sampleCount ( ) const
virtual

Returns the number of samples in the calibration image.

Definition at line 34 of file SpectralDefinition.cpp.

References m_ns.

◆ sectionCount()

int Isis::SpectralDefinition::sectionCount ( ) const
virtual

Returns the number of sections in the calibration image.

Reimplemented in Isis::SpectralDefinition1D, and Isis::SpectralDefinition2D.

Definition at line 59 of file SpectralDefinition.cpp.

References m_numSections.

◆ sectionNumber()

virtual int Isis::SpectralDefinition::sectionNumber ( int s,
int l,
int b ) const
pure virtual

Implemented in Isis::SpectralDefinition1D, and Isis::SpectralDefinition2D.

Member Data Documentation

◆ m_nb

int Isis::SpectralDefinition::m_nb
protected

Number of bands in input Cube.

Definition at line 60 of file SpectralDefinition.h.

Referenced by bandCount(), init(), Isis::SpectralDefinition1D::SpectralDefinition1D(), and Isis::SpectralDefinition2D::SpectralDefinition2D().

◆ m_nl

int Isis::SpectralDefinition::m_nl
protected

Number of lines in input Cube.

Definition at line 57 of file SpectralDefinition.h.

Referenced by init(), lineCount(), Isis::SpectralDefinition1D::SpectralDefinition1D(), and Isis::SpectralDefinition2D::SpectralDefinition2D().

◆ m_ns

int Isis::SpectralDefinition::m_ns
protected

Number of samples in input Cube.

Definition at line 54 of file SpectralDefinition.h.

Referenced by init(), sampleCount(), Isis::SpectralDefinition1D::SpectralDefinition1D(), and Isis::SpectralDefinition2D::SpectralDefinition2D().

◆ m_numSections

int Isis::SpectralDefinition::m_numSections
protected

Number of sections of the chip/wavelength data.

Definition at line 63 of file SpectralDefinition.h.

Referenced by init(), and sectionCount().

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