Isis 3 Programmer Reference
Isis::GainTemperature Class Reference

GaingTemperature Module - Applies temperature-dependant gain correction (column) More...

#include <GainTemperature.h>

Inheritance diagram for Isis::GainTemperature:
Inheritance graph
Collaboration diagram for Isis::GainTemperature:
Collaboration graph

Public Member Functions

 GainTemperature (const HiCalConf &conf)
 
virtual ~GainTemperature ()
 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 HiVectorref () const
 Return data via a const reference.
 
double operator() (int index) const
 Return individual element of the data vector.
 
const HiHistoryHistory () 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.
 

Private Member Functions

void init (const HiCalConf &conf)
 

Private Attributes

std::string _fpaFile
 
double _refTemp
 
double _fpaFactor
 

Detailed Description

GaingTemperature Module - Applies temperature-dependant gain correction (column)

This class computes the temperature dependant gain correction. It has a comma separated value (CSV) file in the config file parameter "FpaTemperatureFactorFile". This file is assumed to contain three columns of data: column 0: CCD identifier (Ex: RED0), column 1: FPA factor for channel 0, and column 2: FPA factor for channel 1. It should have 14 rows, 1 for each HiRISE CCD.

Author
2009-09-14 Kris Becker
History

2010-04-16 Kris Becker Utilize standardized CSV reader to get FpaFactor

2010-05-26 Kris Becker Corrected sign for CSV factor (_fpaFactor)

2016-08-28 Kelvin Rodriguez - Removed usused private member variables to eliminate unused member variables warnings in clang. Part of porting to OS X 10.11.

Definition at line 48 of file GainTemperature.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited

Definition at line 147 of file Module.h.

Constructor & Destructor Documentation

◆ GainTemperature() [1/2]

Isis::GainTemperature::GainTemperature ( )
inline

Definition at line 52 of file GainTemperature.h.

◆ GainTemperature() [2/2]

Isis::GainTemperature::GainTemperature ( const HiCalConf & conf)
inline

Definition at line 53 of file GainTemperature.h.

◆ ~GainTemperature()

virtual Isis::GainTemperature::~GainTemperature ( )
inlinevirtual

Destructor.

Definition at line 58 of file GainTemperature.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 131 of file Module.h.

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

◆ init()

void Isis::GainTemperature::init ( const HiCalConf & conf)
inlineprivate

Definition at line 65 of file GainTemperature.h.

◆ 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 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::ZeroBufferFit, Isis::ZeroBufferSmooth, Isis::ZeroDark, Isis::ZeroDarkRate, and Isis::ZeroReverse.

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

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

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.

◆ 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

◆ _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

◆ _fpaFactor

double Isis::GainTemperature::_fpaFactor
private

Definition at line 63 of file GainTemperature.h.

◆ _fpaFile

std::string Isis::GainTemperature::_fpaFile
private

Definition at line 61 of file GainTemperature.h.

◆ _history

◆ _name

QString Isis::Module::_name
protectedinherited

Name of component.

Definition at line 149 of file Module.h.

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

◆ _refTemp

double Isis::GainTemperature::_refTemp
private

Definition at line 62 of file GainTemperature.h.


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