File failed to load: https://isis.astrogeology.usgs.gov/dev/Object/assets/jax/output/NativeMML/config.js
Isis Developer Reference
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Isis::ZeroBufferSmooth Class Reference
Utility

Processes Buffer calibration data (ZeroBufferSmooth Module) More...

#include <ZeroBufferSmooth.h>

Inheritance diagram for Isis::ZeroBufferSmooth:
Inheritance graph
Collaboration diagram for Isis::ZeroBufferSmooth:
Collaboration graph

Public Member Functions

 ZeroBufferSmooth ()
 
 ZeroBufferSmooth (HiCalData &cal, const HiCalConf &conf)
 Construct with data parameters.
 
virtual ~ZeroBufferSmooth ()
 Destructor.
 
const Statistics & Stats () 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 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.
 

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

Processes Buffer calibration data (ZeroBufferSmooth Module)

This class loads and processes the Buffer data from a HiRISE image for drift correction purposes. The config file contains parameter (ZfFirstSample, ZfLastSample) that indicate which regions of the calibration buffer to extract/use. This region is averaged across the line axis for each line resulting in a single value for each line. The resulting vector is then filtered with a lowpass filter. The filter width (ZfFilterWidth) and number of interations (ZfFilterIterations) are contained within the config file. A spline fit is applied if any missing data remain after filtering.

Author
2008-06-10 Kris Becker

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
DefaultWidth 
DefaultPrecision 

Constructor & Destructor Documentation

◆ ZeroBufferSmooth() [1/2]

Isis::ZeroBufferSmooth::ZeroBufferSmooth ( )
inline

References Isis::Module::Module().

◆ ZeroBufferSmooth() [2/2]

Isis::ZeroBufferSmooth::ZeroBufferSmooth ( HiCalData & cal,
const HiCalConf & conf )
inline

Construct with data parameters.

This constructor completely computes drift from data collected in a HiRISE image

Parameters
calCalibration data collection
confAll necessary parameters for computations

References Isis::Module::Module().

◆ ~ZeroBufferSmooth()

virtual Isis::ZeroBufferSmooth::~ZeroBufferSmooth ( )
inlinevirtual

Destructor.

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

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

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

Referenced by printOn().

◆ getcsvFile()

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

Returns expanded name of last CSV file loaded by loadCsv.

References _csvFile.

◆ History()

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

Return recorded history of events.

References _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
cvsBaseName of base keyword for CSV file
confConfiguration parameters
profModule profile parameters
samplesNumber of expect elements to be read from CSV file
Returns
HiVector

References _csvFile, _history, Isis::LoadCSV::filename(), Isis::LoadCSV::getVector(), Isis::LoadCSV::History(), and Isis::LoadCSV::validateSize().

◆ name()

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

Returns name of component.

References _name.

Referenced by Module(), Module(), and Module().

◆ operator()()

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

Return individual element of the data vector.

References _data.

◆ 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 _data.

◆ Process() [2/2]

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

Invokes the process method on the Module vector.

References Module(), Process(), and ref().

Referenced by Process().

◆ record()

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

Record history in Pvl group object.

References _history.

◆ ref()

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

Return data via a const reference.

References _data.

Referenced by Isis::ZeroBufferFit::guess(), Isis::LowPassFilter::LowPassFilter(), Process(), and Isis::SplineFill::SplineFill().

◆ size()

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

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

References _data.

◆ Stats()

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

Return statistics for filtered - raw Buffer.

Returns
const Statistics& Statistics class with all stats

Member Data Documentation

◆ _csvFile

QString Isis::Module::_csvFile
protectedinherited

Fully expanded name of CSV file if present.

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

◆ _data

HiVector Isis::Module::_data
protectedinherited

Data vector.

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

◆ _fmtPrecision

int Isis::Module::_fmtPrecision
protectedinherited

Default field with of double.

Referenced by formatDbl(), Module(), Module(), Module(), Module(), and Module().

◆ _fmtWidth

int Isis::Module::_fmtWidth
protectedinherited

Default field with of double.

Referenced by formatDbl(), Module(), Module(), Module(), Module(), and Module().

◆ _history

HiHistory Isis::Module::_history
protectedinherited

Hierarchial component history.

Referenced by Isis::ZeroBufferFit::guess(), History(), loadCsv(), Isis::LowPassFilter::LowPassFilter(), Isis::LowPassFilter::LowPassFilter(), Module(), Module(), Module(), Module(), Module(), Isis::ZeroBufferFit::Normalize(), printOn(), Isis::LowPassFilter::Process(), Isis::SplineFill::Process(), 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 Module(), Module(), Module(), Module(), Module(), and name().

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