Isis::GainNonLinearity Class Reference

GainNonLinearity Module - Applies non-linear, line-dependant gain. More...

#include <GainNonLinearity.h>

Inheritance diagram for Isis::GainNonLinearity:

Collaboration diagram for Isis::GainNonLinearity:

Public Member Functions
	GainNonLinearity ()
	GainNonLinearity (const HiCalConf &conf)
virtual	~GainNonLinearity ()
	Destructor.
QString	name () const
	Returns name of component.
QString	getcsvFile () const
	Returns expanded name of last CSV file loaded by loadCsv.
int	size () const
	Returns the size (number of elements) of data array.
virtual void	Process (const Module &c)
	Invokes the process method on the Module vector.
virtual void	Process (const HiVector &v)
	Default processing behavior makes a reference copy of data array.
HiVector	loadCsv (const QString &csvBase, const HiCalConf &conf, const DbProfile &prof, const int &elements=0)
	Provide generic loading of CSV file for all modules.
const HiVector &	ref () const
	Return data via a const reference.
double	operator() (int index) const
	Return individual element of the data vector.
const HiHistory &	History () const
	Return recorded history of events.
virtual void	record (PvlGroup &pvl, const QString keyname="ModuleHistory") const
	Record history in Pvl group object.
void	Dump (const QString &fname) const
	Dumps the component to a specified file.

Protected Types
enum	{ DefaultWidth = 10 , DefaultPrecision = 6 }

Protected Member Functions
QString	formatDbl (const double &value) const
	Properly format values that could be special pixels.
virtual void	printOn (std::ostream &o) const
	Default printing of data in module.

Protected Attributes
QString	_name
	Name of component.
QString	_csvFile
	Fully expanded name of CSV file if present.
HiVector	_data
	Data vector.
HiHistory	_history
	Hierarchial component history.
int	_fmtWidth
	Default field with of double.
int	_fmtPrecision
	Default field with of double.

Detailed Description

GainNonLinearity Module - Applies non-linear, line-dependant gain.

This class computes the line-based non-linearity dependant gain correction. It has a comma separated value (CSV) file in the config file parameter "NonLinearityGain". This file is assumed to contain one column of data: the factor applied to the line average to correct non linear gain contribution.

Author

2010-05-20 Kris Becker

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
DefaultWidth
DefaultPrecision

Constructor & Destructor Documentation

GainNonLinearity() [1/2]

Isis::GainNonLinearity::GainNonLinearity ( )

inline

GainNonLinearity() [2/2]

Isis::GainNonLinearity::GainNonLinearity ( const HiCalConf & conf )

inline

~GainNonLinearity()

virtual Isis::GainNonLinearity::~GainNonLinearity ( )

inlinevirtual

Destructor.

Member Function Documentation

Dump()

void Isis::Module::Dump ( const QString & fname ) const

inlineinherited

Dumps the component to a specified file.

Parameters

fname

Name of file to dump contents to

References _FILEINFO_, and Isis::IException::User.

formatDbl()

QString Isis::Module::formatDbl ( const double & value ) const

inlineprotectedinherited

Properly format values that could be special pixels.

This method applies ISIS special pixel value conventions to properly print pixel values.

Parameters

[in]	(double)	value Input value to test for specialness and print as requested by caller
[in]	(int)	width Width of field in which to print the value
[in]	(int)	prec Precision used to format the value

Returns

(string) Formatted double value

References Isis::Module::_fmtPrecision, Isis::Module::_fmtWidth, Isis::IsSpecial(), and Isis::PixelToString().

Referenced by Isis::Module::printOn().

getcsvFile()

QString Isis::Module::getcsvFile ( ) const

inlineinherited

Returns expanded name of last CSV file loaded by loadCsv.

References Isis::Module::_csvFile.

History()

const HiHistory & Isis::Module::History ( ) const

inlineinherited

Return recorded history of events.

References Isis::Module::_history.

loadCsv()

HiVector Isis::Module::loadCsv ( const QString & csvBase, const HiCalConf & conf, const DbProfile & prof, const int & elements = 0 )

inlineinherited

Provide generic loading of CSV file for all modules.

This method provides generalized access to CSV files through the standardized format.

Author

Kris Becker - 4/16/2010

Parameters

cvsBase	Name of base keyword for CSV file
conf	Configuration parameters
prof	Module profile parameters
samples	Number of expect elements to be read from CSV file

Returns

HiVector

References Isis::Module::_csvFile, and Isis::Module::_history.

name()

QString Isis::Module::name ( ) const

inlineinherited

Returns name of component.

References Isis::Module::_name.

operator()()

double Isis::Module::operator() ( int index ) const

inlineinherited

Return individual element of the data vector.

References Isis::Module::_data.

printOn()

virtual void Isis::Module::printOn ( std::ostream & o ) const

inlineprotectedvirtualinherited

Default printing of data in module.

References Isis::Module::_data, Isis::Module::_history, and Isis::Module::formatDbl().

Process() [1/2]

virtual void Isis::Module::Process ( const HiVector & v )

inlinevirtualinherited

Default processing behavior makes a reference copy of data array.

Reimplemented in Isis::LowPassFilter, and Isis::SplineFill.

References Isis::Module::_data.

Process() [2/2]

virtual void Isis::Module::Process ( const Module & c )

inlinevirtualinherited

Invokes the process method on the Module vector.

References Isis::Module::Process().

Referenced by Isis::Module::Process().

record()

virtual void Isis::Module::record ( PvlGroup & pvl, const QString keyname = "ModuleHistory" ) const

inlinevirtualinherited

Record history in Pvl group object.

References Isis::Module::_history, and Isis::HiHistory::makekey().

ref()

const HiVector & Isis::Module::ref ( ) const

inlineinherited

Return data via a const reference.

References Isis::Module::_data.

size()

int Isis::Module::size ( ) const

inlineinherited

Returns the size (number of elements) of data array.

References Isis::Module::_data.

Member Data Documentation

_csvFile

QString Isis::Module::_csvFile

protectedinherited

Fully expanded name of CSV file if present.

Referenced by Isis::Module::getcsvFile(), and Isis::Module::loadCsv().

_data

HiVector Isis::Module::_data

protectedinherited

Data vector.

Referenced by Isis::LowPassFilter::LowPassFilter(), Isis::LowPassFilter::LowPassFilter(), Isis::Module::operator()(), Isis::Module::printOn(), Isis::LowPassFilter::Process(), Isis::Module::Process(), Isis::Module::ref(), and Isis::Module::size().

_fmtPrecision

int Isis::Module::_fmtPrecision

protectedinherited

Default field with of double.

Referenced by Isis::Module::formatDbl().

_fmtWidth

int Isis::Module::_fmtWidth

protectedinherited

Default field with of double.

Referenced by Isis::Module::formatDbl().

_history

HiHistory Isis::Module::_history

protectedinherited

Hierarchial component history.

Referenced by Isis::ZeroBufferFit::guess(), Isis::Module::History(), Isis::Module::loadCsv(), Isis::LowPassFilter::LowPassFilter(), Isis::LowPassFilter::LowPassFilter(), Isis::ZeroBufferFit::Normalize(), Isis::Module::printOn(), Isis::LowPassFilter::Process(), Isis::SplineFill::Process(), Isis::Module::record(), Isis::ZeroBufferFit::Solve(), Isis::SplineFill::SplineFill(), Isis::SplineFill::SplineFill(), Isis::SplineFill::SplineFill(), and Isis::ZeroBufferFit::ZeroBufferFit().

_name

QString Isis::Module::_name

protectedinherited

Name of component.

Referenced by Isis::Module::name().

---

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

• /Users/astamile/ISIS3/isis/src/mro/objs/HiCal/GainNonLinearity.h