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 (const HiCalConf &conf)

virtual	~GainNonLinearity ()
	Destructor. More...

QString	name () const
	Returns name of component. More...

QString	getcsvFile () const
	Returns expanded name of last CSV file loaded by loadCsv. More...

int	size () const
	Returns the size (number of elements) of data array. More...

virtual void	Process (const Module &c)
	Invokes the process method on the Module vector. More...

virtual void	Process (const HiVector &v)
	Default processing behavior makes a reference copy of data array. More...

HiVector	loadCsv (const QString &csvBase, const HiCalConf &conf, const DbProfile &prof, const int &elements=0)
	Provide generic loading of CSV file for all modules. More...

const HiVector &	ref () const
	Return data via a const reference. More...

double	operator() (int index) const
	Return individual element of the data vector. More...

const HiHistory &	History () const
	Return recorded history of events. More...

virtual void	record (PvlGroup &pvl, const QString keyname="ModuleHistory") const
	Record history in Pvl group object. More...

void	Dump (const QString &fname) const
	Dumps the component to a specified file. More...

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

Protected Member Functions
QString	formatDbl (const double &value) const
	Properly format values that could be special pixels. More...

virtual void	printOn (std::ostream &o) const
	Default printing of data in module. More...

Protected Attributes
QString	_name
	Name of component. More...

QString	_csvFile
	Fully expanded name of CSV file if present. More...

HiVector	_data
	Data vector. More...

HiHistory	_history
	Hierarchial component history. More...

int	_fmtWidth
	Default field with of double. More...

int	_fmtPrecision
	Default field with of double. More...

Private Member Functions
void	init (const HiCalConf &conf)

Private Attributes
std::string	_gainFile

double	_gainFactor

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

Definition at line 39 of file GainNonLinearity.h.

Constructor & Destructor Documentation

◆ ~GainNonLinearity()

virtual Isis::GainNonLinearity::~GainNonLinearity ( )

inlinevirtual

Destructor.

Definition at line 49 of file GainNonLinearity.h.

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

Definition at line 131 of file Module.h.

References Isis::FileName::expanded(), 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

Definition at line 169 of file Module.h.

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

Referenced by Isis::Module::printOn(), Isis::ZeroBufferFit::printOn(), Isis::ZeroBufferSmooth::printOn(), Isis::ZeroDark::printOn(), Isis::ZeroDarkRate::printOn(), and Isis::ZeroReverse::printOn().

◆ getcsvFile()

QString Isis::Module::getcsvFile ( ) const

inlineinherited

Returns expanded name of last CSV file loaded by loadCsv.

Definition at line 71 of file Module.h.

References Isis::Module::_csvFile.

◆ History()

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

inlineinherited

Return recorded history of events.

Definition at line 116 of file Module.h.

References Isis::Module::_history.

Referenced by Isis::ZeroBufferSmooth::init(), and Isis::ZeroReverse::init().

◆ 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

Definition at line 101 of file Module.h.

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

◆ name()

QString Isis::Module::name ( ) const

inlineinherited

Returns name of component.

Definition at line 69 of file Module.h.

References Isis::Module::_name.

◆ operator()()

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

inlineinherited

Return individual element of the data vector.

Definition at line 113 of file Module.h.

References Isis::Module::_data.

◆ printOn()

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

inlineprotectedvirtualinherited

Default printing of data in module.

Reimplemented in Isis::ZeroReverse, Isis::ZeroDarkRate, Isis::ZeroDark, Isis::ZeroBufferSmooth, and Isis::ZeroBufferFit.

Definition at line 183 of file Module.h.

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::SplineFill, and Isis::LowPassFilter.

Definition at line 81 of file Module.h.

References Isis::Module::_data.

◆ Process() [2/2]

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

inlinevirtualinherited

Invokes the process method on the Module vector.

Definition at line 76 of file Module.h.

References Isis::Module::ref().

◆ record()

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

inlinevirtualinherited

Record history in Pvl group object.

Definition at line 119 of file Module.h.

References Isis::Module::_history.

◆ ref()

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

inlineinherited

Return data via a const reference.

Definition at line 111 of file Module.h.

References Isis::Module::_data.

Referenced by Isis::ZeroBufferFit::guess(), Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), and Isis::Module::Process().

◆ size()

int Isis::Module::size ( ) const

inlineinherited

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

Definition at line 73 of file Module.h.

References Isis::Module::_data.

Member Data Documentation

◆ _csvFile

QString Isis::Module::_csvFile

protectedinherited

Fully expanded name of CSV file if present.

Definition at line 150 of file Module.h.

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

◆ _data

HiVector Isis::Module::_data

protectedinherited

Data vector.

Definition at line 151 of file Module.h.

Referenced by Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), Isis::Module::operator()(), Isis::Module::printOn(), Isis::ZeroBufferSmooth::printOn(), Isis::ZeroDark::printOn(), Isis::ZeroDarkRate::printOn(), Isis::ZeroReverse::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.

Definition at line 154 of file Module.h.

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

◆ _fmtWidth

int Isis::Module::_fmtWidth

protectedinherited

Default field with of double.

Definition at line 153 of file Module.h.

Referenced by Isis::Module::formatDbl(), Isis::ZeroBufferFit::printOn(), Isis::ZeroBufferSmooth::printOn(), Isis::ZeroDark::printOn(), Isis::ZeroDarkRate::printOn(), and Isis::ZeroReverse::printOn().

◆ _history

HiHistory Isis::Module::_history

protectedinherited

◆ _name

QString Isis::Module::_name

protectedinherited

Name of component.

Definition at line 149 of file Module.h.

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

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

src/mro/objs/HiCal/GainNonLinearity.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~GainNonLinearity()

Member Function Documentation

◆ Dump()

◆ formatDbl()

◆ getcsvFile()

◆ History()

◆ loadCsv()

◆ name()

◆ operator()()

◆ printOn()

◆ Process() [1/2]

◆ Process() [2/2]

◆ record()

◆ ref()

◆ size()

Member Data Documentation

◆ _csvFile

◆ _data

◆ _fmtPrecision

◆ _fmtWidth

◆ _history

◆ _name