Isis 3 Programmer Reference
Isis::GainFlatField Class Reference

GainFlatField Module - Computes flat field correction for sample. More...

#include <GainFlatField.h>

Inheritance diagram for Isis::GainFlatField:
Inheritance graph
Collaboration diagram for Isis::GainFlatField:
Collaboration graph

Public Member Functions

 GainFlatField (const HiCalConf &conf)
 
virtual ~GainFlatField ()
 Destructor. More...
 
const StatisticsStats () const
 Return statistics A matrix corection. 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 HiVectorref () const
 Return data via a const reference. More...
 
double operator() (int index) const
 Return individual element of the data vector. More...
 
const HiHistoryHistory () 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 _amatrix
 
Statistics _stats
 

Detailed Description

GainFlatField Module - Computes flat field correction for sample.

This class computes the HiRISE flat field correction component using the A matrix.

Author
2008-03-04 Kris Becker
History:

2009-09-14 Kris Becker Removed temperature components and placed them in the GainTemperature module.

2010-04-16 Kris Becker Modified to used the standardized CSV reader for the A matrix.

Definition at line 55 of file GainFlatField.h.

Constructor & Destructor Documentation

◆ ~GainFlatField()

virtual Isis::GainFlatField::~GainFlatField ( )
inlinevirtual

Destructor.

Definition at line 65 of file GainFlatField.h.

Member Function Documentation

◆ Dump()

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

Dumps the component to a specified file.

Parameters
fnameName of file to dump contents to

Definition at line 146 of file Module.h.

References _FILEINFO_, 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 184 of file Module.h.

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

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

◆ getcsvFile()

QString Isis::Module::getcsvFile ( ) const
inlineinherited

Returns expanded name of last CSV file loaded by loadCsv.

Definition at line 86 of file Module.h.

References Isis::Module::_csvFile.

◆ History()

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

Return recorded history of events.

Definition at line 131 of file Module.h.

References Isis::Module::_history.

Referenced by Isis::ZeroReverse::init(), and Isis::ZeroBufferSmooth::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
cvsBaseName of base keyword for CSV file
confConfiguration parameters
profModule profile parameters
samplesNumber of expect elements to be read from CSV file
Returns
HiVector

Definition at line 116 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 84 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 128 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::ZeroDark, Isis::ZeroBufferFit, and Isis::ZeroBufferSmooth.

Definition at line 198 of file Module.h.

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

◆ Process() [1/2]

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

Invokes the process method on the Module vector.

Definition at line 91 of file Module.h.

References Isis::Module::ref().

◆ Process() [2/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 96 of file Module.h.

References Isis::Module::_data.

◆ record()

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

Record history in Pvl group object.

Definition at line 134 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 126 of file Module.h.

References Isis::Module::_data.

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

◆ size()

int Isis::Module::size ( ) const
inlineinherited

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

Definition at line 88 of file Module.h.

References Isis::Module::_data.

◆ Stats()

const Statistics& Isis::GainFlatField::Stats ( ) const
inline

Return statistics A matrix corection.

Returns
const Statistics& Statistics class with all stats

Definition at line 72 of file GainFlatField.h.

Member Data Documentation

◆ _csvFile

QString Isis::Module::_csvFile
protectedinherited

Fully expanded name of CSV file if present.

Definition at line 165 of file Module.h.

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

◆ _data

◆ _fmtPrecision

int Isis::Module::_fmtPrecision
protectedinherited

Default field with of double.

Definition at line 169 of file Module.h.

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

◆ _fmtWidth

int Isis::Module::_fmtWidth
protectedinherited

◆ _history

◆ _name

QString Isis::Module::_name
protectedinherited

Name of component.

Definition at line 164 of file Module.h.

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


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