A Spectral definition that includes wavelength and center values for each (line, sample) coordinate. More...

#include <SpectralDefinition2D.h>

Inheritance diagram for Isis::SpectralDefinition2D:

Collaboration diagram for Isis::SpectralDefinition2D:

Public Member Functions
	SpectralDefinition2D (FileName smileDefFilename)
	Construct a SpectralDefinition2D object using a filename. More...

	~SpectralDefinition2D ()
	destructor More...

Spectel	findSpectel (const int sample, const int line, const int band) const
	Get the Spectel at some sample, line, band (associated with your input/calibration file) More...

Spectel	findSpectelByWavelength (const double wavelength, const int sectionNumber) const

Spectel	findSpectel (const Spectel &inSpectel, const int sectionNumber) const

virtual int	sectionCount () const
	Returns the number of sections in the calibration image. More...

int	sectionNumber (int s, int l, int b) const
	returns section number given (s,l,b) More...

QString	toString ()
	Returns QString representation of SpectralDefinition2D. More...

void	operator() (Buffer &in) const
	Internal function used to help read-in a calibration cube. More...

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...

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...

Private Member Functions
void	init ()
	Constructor initializer. More...

Private Attributes
QList< QList< Spectel > * > *	m_spectelList
	Internally represent the samples x 2 lines x n bands calibration file Outside list is the sample index, inside list is the band. More...

int	m_numSections
	The number of sections of this Spectral Definition. More...

QList< int > *	m_sectionList
	The list of sections. More...

Detailed Description

A Spectral definition that includes wavelength and center values for each (line, sample) coordinate.

Author: 2015-05-21 Kristin Berry

History:: 2015-06-09 Stuart Sides - Removed WavelengthsAndWidths storage class and used Spectel

History:: 2015-06-12 Stuart Sides - Added getSpectel(spectel) and constness

History:: 2015-06-13 Kristin Berry - Added sections (wavelengths are not all contiguous)

History:: 2015-06-14 Stuart Sides - Removed global varaiables

History:: 2015-08-09 Kristin Berry - Updated to get closer to Isis Coding Standards.

Definition at line 35 of file SpectralDefinition2D.h.

Constructor & Destructor Documentation

◆ SpectralDefinition2D()

Isis::SpectralDefinition2D::SpectralDefinition2D ( FileName smileDefFilename )

Construct a SpectralDefinition2D object using a filename.

Isis Cubes are the only supported format.

Author: 2015-05021 Kristin Berry

Parameters

smileDefFilename the filename of the spectral definition

Definition at line 26 of file SpectralDefinition2D.cpp.

References Isis::Cube::bandCount(), Isis::FileName::expanded(), Isis::ProcessByBrick::Finalize(), Isis::Cube::lineCount(), Isis::SpectralDefinition::m_nb, Isis::SpectralDefinition::m_nl, Isis::SpectralDefinition::m_ns, m_numSections, m_sectionList, m_spectelList, Isis::ProcessBySample::ProcessCubeInPlace(), Isis::Process::Progress(), Isis::Cube::sampleCount(), Isis::ProcessBySample::SetInputCube(), Isis::ProcessByBrick::SetProcessingDirection(), Isis::Progress::SetText(), Isis::FileName::toString(), Isis::IException::Unknown, and Isis::IException::User.

◆ ~SpectralDefinition2D()

Isis::SpectralDefinition2D::~SpectralDefinition2D ( )

destructor

Definition at line 96 of file SpectralDefinition2D.cpp.

References m_sectionList, and m_spectelList.

Member Function Documentation

◆ bandCount()

int Isis::SpectralDefinition::bandCount ( ) const

virtualinherited

Returns the number of bands in the calibration image.

Definition at line 50 of file SpectralDefinition.cpp.

References Isis::SpectralDefinition::m_nb.

◆ findSpectel()

Spectel Isis::SpectralDefinition2D::findSpectel	(	const int	sample,
		const int	line,
		const int	band
	)		const

virtual

Get the Spectel at some sample, line, band (associated with your input/calibration file)

Author: 2015-05-21 Kristin Berry

Parameters

sample	input sample
line	input line. Not used for a 2D definition
band	input band

Returns: Spectel

Implements Isis::SpectralDefinition.

Definition at line 113 of file SpectralDefinition2D.cpp.

References m_spectelList.

◆ init()

void Isis::SpectralDefinition::init ( )

privateinherited

Constructor initializer.

Definition at line 65 of file SpectralDefinition.cpp.

References Isis::SpectralDefinition::m_nb, Isis::SpectralDefinition::m_nl, Isis::SpectralDefinition::m_ns, and Isis::SpectralDefinition::m_numSections.

Referenced by Isis::SpectralDefinition::SpectralDefinition().

◆ lineCount()

int Isis::SpectralDefinition::lineCount ( ) const

virtualinherited

Returns the number of line in the calibration image.

Definition at line 42 of file SpectralDefinition.cpp.

References Isis::SpectralDefinition::m_nl.

◆ operator()()

void Isis::SpectralDefinition2D::operator() ( Buffer & in ) const

Internal function used to help read-in a calibration cube.

pull information out of the input cube and store it. Each buffer contains two pixels, one center and one width

Definition at line 195 of file SpectralDefinition2D.cpp.

References Isis::Buffer::Band(), m_sectionList, m_spectelList, and Isis::Buffer::Sample().

◆ sampleCount()

int Isis::SpectralDefinition::sampleCount ( ) const

virtualinherited

Returns the number of samples in the calibration image.

Definition at line 34 of file SpectralDefinition.cpp.

References Isis::SpectralDefinition::m_ns.

◆ sectionCount()

int Isis::SpectralDefinition2D::sectionCount ( ) const

virtual

Returns the number of sections in the calibration image.

Reimplemented from Isis::SpectralDefinition.

Definition at line 71 of file SpectralDefinition2D.cpp.

References m_numSections.

◆ sectionNumber()

int Isis::SpectralDefinition2D::sectionNumber	(	int	s,
		int	l,
		int	b
	)		const

virtual

returns section number given (s,l,b)

Implements Isis::SpectralDefinition.

Definition at line 77 of file SpectralDefinition2D.cpp.

References m_sectionList.

◆ toString()

QString Isis::SpectralDefinition2D::toString ( )

Returns QString representation of SpectralDefinition2D.

Author: Kristin L Berry

Returns: QString String representation of SpectralDefinition2D

Definition at line 172 of file SpectralDefinition2D.cpp.

References Isis::Spectel::centerWavelength(), Isis::Spectel::filterWidth(), and m_spectelList.

Member Data Documentation

◆ m_nb

int Isis::SpectralDefinition::m_nb

protectedinherited

Number of bands in input Cube.

Definition at line 60 of file SpectralDefinition.h.

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

◆ m_nl

int Isis::SpectralDefinition::m_nl

protectedinherited

Number of lines in input Cube.

Definition at line 57 of file SpectralDefinition.h.

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

◆ m_ns

int Isis::SpectralDefinition::m_ns

protectedinherited

Number of samples in input Cube.

Definition at line 54 of file SpectralDefinition.h.

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

◆ m_numSections

int Isis::SpectralDefinition2D::m_numSections

private

The number of sections of this Spectral Definition.

Definition at line 57 of file SpectralDefinition2D.h.

Referenced by sectionCount(), and SpectralDefinition2D().

◆ m_sectionList

QList<int>* Isis::SpectralDefinition2D::m_sectionList

private

The list of sections.

Definition at line 59 of file SpectralDefinition2D.h.

Referenced by operator()(), sectionNumber(), SpectralDefinition2D(), and ~SpectralDefinition2D().

◆ m_spectelList

QList<QList<Spectel> *>* Isis::SpectralDefinition2D::m_spectelList

private

Internally represent the samples x 2 lines x n bands calibration file Outside list is the sample index, inside list is the band.

Definition at line 55 of file SpectralDefinition2D.h.

Referenced by findSpectel(), operator()(), SpectralDefinition2D(), toString(), and ~SpectralDefinition2D().

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

src/base/objs/SpectralDefinition2D/SpectralDefinition2D.h
src/base/objs/SpectralDefinition2D/SpectralDefinition2D.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SpectralDefinition2D()

◆ ~SpectralDefinition2D()

Member Function Documentation

◆ bandCount()

◆ findSpectel()

◆ init()

◆ lineCount()

◆ operator()()

◆ sampleCount()

◆ sectionCount()

◆ sectionNumber()

◆ toString()

Member Data Documentation

◆ m_nb

◆ m_nl

◆ m_ns

◆ m_numSections

◆ m_sectionList

◆ m_spectelList