Module manages HiRISE calibration vectors from various sources. More...

#include <Module.h>

Inheritance diagram for Isis::Module:

Collaboration diagram for Isis::Module:

Public Member Functions
	Module ()

	Module (const QString &name)

	Module (const QString &name, const HiHistory &history)

	Module (const QString &name, const Module &c)

	Module (const Module &c)

virtual	~Module ()
	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...

Friends
std::ostream &	operator<< (std::ostream &o, const Module &c)

Detailed Description

Module manages HiRISE calibration vectors from various sources.

Author: 2007-10-05 Kris Becker

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
DefaultWidth
DefaultPrecision

Constructor & Destructor Documentation

◆ Module() [1/5]

Isis::Module::Module ( )

inline

◆ Module() [2/5]

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

inline

◆ Module() [3/5]

Isis::Module::Module	(	const QString &	name,
		const HiHistory &	history
	)

inline

◆ Module() [4/5]

Isis::Module::Module	(	const QString &	name,
		const Module &	c
	)

inline

◆ Module() [5/5]

Isis::Module::Module ( const Module & c )

inline

◆ ~Module()

virtual Isis::Module::~Module ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Dump()

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

inline

Dumps the component to a specified file.

Parameters

fname Name of file to dump contents to

References _FILEINFO_, Isis::FileName::expanded(), and Isis::IException::User.

◆ formatDbl()

QString Isis::Module::formatDbl ( const double & value ) const

inlineprotected

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

inline

Returns expanded name of last CSV file loaded by loadCsv.

References _csvFile.

◆ History()

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

inline

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`
	)

inline

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

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

◆ name()

QString Isis::Module::name ( ) const

inline

Returns name of component.

References _name.

◆ operator()()

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

inline

Return individual element of the data vector.

References _data.

◆ printOn()

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

inlineprotectedvirtual

Default printing of data in module.

References _data, _history, and formatDbl().

◆ Process() [1/2]

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

inlinevirtual

Invokes the process method on the Module vector.

References ref().

◆ Process() [2/2]

virtual void Isis::Module::Process ( const HiVector & v )

inlinevirtual

Default processing behavior makes a reference copy of data array.

Reimplemented in Isis::SplineFill, and Isis::LowPassFilter.

References _data.

◆ record()

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

inlinevirtual

Record history in Pvl group object.

References _history, and Isis::HiHistory::makekey().

◆ ref()

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

inline

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

inline

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

References _data.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	o,
		const Module &	c
	)

friend

Member Data Documentation

◆ _csvFile

QString Isis::Module::_csvFile

protected

Fully expanded name of CSV file if present.

Referenced by getcsvFile(), and loadCsv().

◆ _data

HiVector Isis::Module::_data

protected

Data vector.

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

◆ _fmtPrecision

int Isis::Module::_fmtPrecision

protected

Default field with of double.

Referenced by formatDbl().

◆ _fmtWidth

int Isis::Module::_fmtWidth

protected

Default field with of double.

Referenced by formatDbl().

◆ _history

HiHistory Isis::Module::_history

protected

Hierarchial component history.

Referenced by Isis::ZeroBufferFit::guess(), History(), loadCsv(), Isis::LowPassFilter::LowPassFilter(), Isis::ZeroBufferFit::Normalize(), printOn(), Isis::LowPassFilter::Process(), Isis::SplineFill::Process(), record(), Isis::ZeroBufferFit::Solve(), Isis::SplineFill::SplineFill(), and Isis::ZeroBufferFit::ZeroBufferFit().

◆ _name

QString Isis::Module::_name

protected

Name of component.

Referenced by name().

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

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/mro/objs/HiCal/Module.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Module() [1/5]

◆ Module() [2/5]

◆ Module() [3/5]

◆ Module() [4/5]

◆ Module() [5/5]

◆ ~Module()

Member Function Documentation

◆ Dump()

◆ formatDbl()

◆ getcsvFile()

◆ History()

◆ loadCsv()

◆ name()

◆ operator()()

◆ printOn()

◆ Process() [1/2]

◆ Process() [2/2]

◆ record()

◆ ref()

◆ size()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ _csvFile

◆ _data

◆ _fmtPrecision

◆ _fmtWidth

◆ _history

◆ _name