Isis 3 Programmer Reference
Isis::ZeroDarkRate Class Reference

Computes a complex dark subtraction component (ZeroDarkRate module) More...

#include <ZeroDarkRate.h>

Inheritance diagram for Isis::ZeroDarkRate:
Inheritance graph
Collaboration diagram for Isis::ZeroDarkRate:
Collaboration graph

Public Member Functions

 ZeroDarkRate (const HiCalConf &conf)
 
virtual ~ZeroDarkRate ()
 Destructor.
 
const StatisticsStats () const
 Return statistics for filtered - raw Buffer.
 
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.
 

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)
 
virtual void printOn (std::ostream &o) const
 Virtualized data dump method.
 

Private Attributes

int _tdi
 
int _bin
 
double _temp
 
HiMatrix _coeffMat
 The coefficients are stored in a csv text file as a 3-column, 1024/bin row matrix.
 
Statistics _stats
 

Detailed Description

Computes a complex dark subtraction component (ZeroDarkRate module)

This class computes the HiRISE dark correction component using a combination of the B matrix, slope/intercept components and temperature profiles.

Author
2021-02-28 Moses Milazzo
History
2021-02-28 Moses Milazzo Copied - "ZeroDarkRate.h" to new file "ZeroDarkRate.h" to add new dark current correction model. This model no longer uses the B matrices and instead uses a temperature-dependent exponential model to calculate the correction on a per-image basis. dc_rate = a * exp(b*FPA_T) + c

Definition at line 47 of file ZeroDarkRate.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited

Definition at line 147 of file Module.h.

Constructor & Destructor Documentation

◆ ZeroDarkRate() [1/2]

Isis::ZeroDarkRate::ZeroDarkRate ( )
inline

Definition at line 51 of file ZeroDarkRate.h.

◆ ZeroDarkRate() [2/2]

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

Definition at line 52 of file ZeroDarkRate.h.

◆ ~ZeroDarkRate()

virtual Isis::ZeroDarkRate::~ZeroDarkRate ( )
inlinevirtual

Destructor.

Definition at line 57 of file ZeroDarkRate.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(), 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::ZeroDarkRate::init ( const HiCalConf & conf)
inlineprivate

Definition at line 79 of file ZeroDarkRate.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::ZeroDarkRate::printOn ( std::ostream & o) const
inlineprivatevirtual

Virtualized data dump method.

Reimplemented from Isis::Module.

Definition at line 136 of file ZeroDarkRate.h.

References Isis::Module::_data, Isis::Module::_fmtWidth, 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.

◆ Stats()

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

Return statistics for filtered - raw Buffer.

Returns
const Statistics& Statistics class with all stats

Definition at line 64 of file ZeroDarkRate.h.

Member Data Documentation

◆ _bin

int Isis::ZeroDarkRate::_bin
private

Definition at line 68 of file ZeroDarkRate.h.

◆ _coeffMat

HiMatrix Isis::ZeroDarkRate::_coeffMat
private

The coefficients are stored in a csv text file as a 3-column, 1024/bin row matrix.

Definition at line 75 of file ZeroDarkRate.h.

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

◆ _history

◆ _name

QString Isis::Module::_name
protectedinherited

Name of component.

Definition at line 149 of file Module.h.

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

◆ _stats

Statistics Isis::ZeroDarkRate::_stats
private

Definition at line 77 of file ZeroDarkRate.h.

◆ _tdi

int Isis::ZeroDarkRate::_tdi
private

Definition at line 67 of file ZeroDarkRate.h.

◆ _temp

double Isis::ZeroDarkRate::_temp
private

Definition at line 69 of file ZeroDarkRate.h.


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