Isis Developer Reference
Public Member Functions | Protected Attributes | 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. More...
 
virtual ~SpectralDefinition ()
 default destructor More...
 
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. More...
 
virtual int lineCount () const
 Returns the number of line in the calibration image. More...
 
virtual int bandCount () const
 Returns the number of bands in the calibration image. More...
 
virtual int sectionCount () const
 Returns the number of sections in the calibration image. More...
 
virtual int sectionNumber (int s, int l, int b) const =0
 

Protected Attributes

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

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

Constructor & Destructor Documentation

◆ SpectralDefinition()

Isis::SpectralDefinition::SpectralDefinition ( )

Constructs an empty SpectralDefinition object.

◆ ~SpectralDefinition()

Isis::SpectralDefinition::~SpectralDefinition ( )
virtual

default destructor

Member Function Documentation

◆ bandCount()

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

Returns the number of bands in the calibration image.

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::SpectralDefinition2D, and Isis::SpectralDefinition1D.

◆ findSpectel() [2/2]

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

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

◆ findSpectelByWavelength()

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

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

◆ lineCount()

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

Returns the number of line in the calibration image.

References m_nl.

◆ sampleCount()

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

Returns the number of samples in the calibration image.

References m_ns.

◆ sectionCount()

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

Returns the number of sections in the calibration image.

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

References m_numSections.

◆ sectionNumber()

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

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

Member Data Documentation

◆ m_nb

int Isis::SpectralDefinition::m_nb
protected

Number of bands in input Cube.

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

◆ m_nl

int Isis::SpectralDefinition::m_nl
protected

Number of lines in input Cube.

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

◆ m_ns

int Isis::SpectralDefinition::m_ns
protected

Number of samples in input Cube.

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

◆ m_numSections

int Isis::SpectralDefinition::m_numSections
protected

Number of sections of the chip/wavelength data.

Referenced by sectionCount().

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