MonoStation::AbstractToolParameters Class Reference

Brief description of class still missing. More...

#include <AbstractToolParameters.h>

Inheritance diagram for MonoStation::AbstractToolParameters:

List of all members.

Public Types
enum	HorizontalType { Energy, Azimuth, Squared }
Public Member Functions
	AbstractToolParameters ()
virtual void	collectKeywords (PARAMETERS_COLLECTKEYWORDS_ARGS)
const bool &	computeAverage () const
bool	doMakeUp () const
const double &	highPassFrequency () const
HorizontalType	horizontal () const
const double &	horizontalAzimuth () const
QString	horizontalString () const
virtual int	keywordCount (PARAMETERS_KEYWORDCOUNT_ARGS)
const QString &	makeUpResults () const
const QString &	makeUpSummary () const
const double &	pageHeightResults () const
const int &	plotCountPerLineResults () const
SamplingParameters &	sampling ()
const SamplingParameters &	sampling () const
void	setComputeAverage (const bool &c)
void	setDoMakeUp (bool d)
void	setHighPassFrequency (const double &h)
void	setHorizontal (HorizontalType h)
void	setHorizontal (const QString &h)
void	setHorizontalAzimuth (const double &h)
void	setMakeUpResults (const QString &m)
void	setMakeUpSummary (const QString &m)
void	setPageHeightResults (const double &p)
void	setPlotCountPerLineResults (const int &p)
void	setSampling (const SamplingParameters &s)
void	setSmoothing (const SmoothingParameters &s)
void	setTapering (const TaperParameters &t)
virtual bool	setValue (PARAMETERS_SETVALUE_ARGS)
void	setWindowing (const WindowingParameters &w)
SmoothingParameters &	smoothing ()
const SmoothingParameters &	smoothing () const
TaperParameters &	tapering ()
const TaperParameters &	tapering () const
virtual QString	toString (PARAMETERS_TOSTRING_ARGS_DECL) const
WindowingParameters &	windowing ()
const WindowingParameters &	windowing () const
	~AbstractToolParameters ()

---

Detailed Description

Brief description of class still missing.

Full description of class still missing

---

Member Enumeration Documentation

enum MonoStation::AbstractToolParameters::HorizontalType

Enumerator:

Energy
Azimuth
Squared

{Energy, Azimuth, Squared};

---

Constructor & Destructor Documentation

MonoStation::AbstractToolParameters::AbstractToolParameters

(

)

Description of constructor still missing

References GeopsyCore::TaperParameters::setAlpha(), GeopsyCore::TaperParameters::setWindow(), Squared, and TRACE.

    : AbstractParameters()
  {
    TRACE;
    _plotCountPerLineResults=2;
    _highPassFrequency=0;
    _horizontal=Squared;
    _pageHeightResults=29.7;
    _horizontalAzimuth=0.0;
    _tapering.setWindow(TaperParameters::Tukey);
    _tapering.setAlpha(0.1);
    _doMakeUp=true;
  }

MonoStation::AbstractToolParameters::~AbstractToolParameters

(

)

Description of destructor still missing

References TRACE.

  {
    TRACE;
  }

---

Member Function Documentation

void MonoStation::AbstractToolParameters::collectKeywords

(

PARAMETERS_COLLECTKEYWORDS_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References QGpCoreTools::SmoothingParameters::collectKeywords(), GeopsyCore::TaperParameters::collectKeywords(), QGpCoreTools::SamplingParameters::collectKeywords(), GeopsyCore::WindowingParameters::collectKeywords(), and TRACE.

  {
    TRACE;
    keywords.add(prefix+"DO HIGH PASS", this, 0);
    keywords.add(prefix+"HIGH PASS FREQUENCY", this, 1);
    keywords.add(prefix+"HORIZONTAL COMPONENTS", this, 2);
    keywords.add(prefix+"HORIZONTAL AZIMUTH", this, 3);
    _windowing.collectKeywords(keywords, prefix);
    _smoothing.collectKeywords(keywords, prefix);
    _tapering.collectKeywords(keywords, prefix);
    _sampling.collectKeywords(keywords, prefix);
  }

const bool& MonoStation::AbstractToolParameters::computeAverage

(

)

const [inline]

{return _computeAverage;}

bool MonoStation::AbstractToolParameters::doMakeUp

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters(), and MonoStation::AbstractTool::start().

{return _doMakeUp;}

const double& MonoStation::AbstractToolParameters::highPassFrequency

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters(), and MonoStation::AbstractTool::start().

{return _highPassFrequency;}

HorizontalType MonoStation::AbstractToolParameters::horizontal

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters().

{return _horizontal;}

const double& MonoStation::AbstractToolParameters::horizontalAzimuth

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters().

{return _horizontalAzimuth;}

QString MonoStation::AbstractToolParameters::horizontalString

(

)

const

References Azimuth, Energy, Squared, and TRACE.

Referenced by toString().

  {
    TRACE;
    switch(_horizontal) {
    case Energy:
      break;
    case Azimuth:
      return "Azimuth";
    case Squared:
      return "Squared";
    }
    return "Energy";
  }

int MonoStation::AbstractToolParameters::keywordCount

(

PARAMETERS_KEYWORDCOUNT_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

  {
    return 4;
  }

const QString& MonoStation::AbstractToolParameters::makeUpResults

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters(), and MonoStation::AbstractTool::startMakeUp().

{return _makeUpResults;}

const QString& MonoStation::AbstractToolParameters::makeUpSummary

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters(), and MonoStation::AbstractTool::startMakeUp().

{return _makeUpSummary;}

const double& MonoStation::AbstractToolParameters::pageHeightResults

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters(), and MonoStation::AbstractTool::startMakeUp().

{return _pageHeightResults;}

const int& MonoStation::AbstractToolParameters::plotCountPerLineResults

(

)

const [inline]

Referenced by MonoStation::AbstractToold::setParameters(), and MonoStation::AbstractTool::startMakeUp().

{return _plotCountPerLineResults;}

SamplingParameters& MonoStation::AbstractToolParameters::sampling

(

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters(), HVStationSignals::horizontal(), MonoStation::AbstractToold::setParameters(), StructureStationProcessSignals::setProcessed(), HVStationSignals::setProcessed(), MonoStation::SpectrumStationSignals::setProcessed(), SpectrumRotateStation::start(), HVRotateStation::start(), SpectrumStation::start(), HVStation::start(), and StructureStation::start().

{return _sampling;}

const SamplingParameters& MonoStation::AbstractToolParameters::sampling

(

)

const [inline]

{return _sampling;}

void MonoStation::AbstractToolParameters::setComputeAverage

(

const bool &

c

)

[inline]

{_computeAverage=c;}

void MonoStation::AbstractToolParameters::setDoMakeUp

(

bool

d

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_doMakeUp=d;}

void MonoStation::AbstractToolParameters::setHighPassFrequency

(

const double &

h

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_highPassFrequency=h;}

void MonoStation::AbstractToolParameters::setHorizontal

(

HorizontalType

h

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters(), and setValue().

{_horizontal=h;}

void MonoStation::AbstractToolParameters::setHorizontal

(

const QString &

h

)

References Azimuth, Energy, Squared, and TRACE.

  {
    TRACE;
    if(h.count()>0) {
      QString hl=h.toLower();
      switch(hl[0].unicode()) {
      case 'e':
        if(hl=="energy") {
          _horizontal=Energy;
        }
        break;
      case 'a':
        if(hl=="azimuth") {
          _horizontal=Azimuth;
        }
        break;
      case 's':
        if(hl=="squared") {
          _horizontal=Squared;
        }
        break;
      default:
        break;
      }
    }
  }

void MonoStation::AbstractToolParameters::setHorizontalAzimuth

(

const double &

h

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_horizontalAzimuth=h;}

void MonoStation::AbstractToolParameters::setMakeUpResults

(

const QString &

m

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_makeUpResults=m;}

void MonoStation::AbstractToolParameters::setMakeUpSummary

(

const QString &

m

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_makeUpSummary=m;}

void MonoStation::AbstractToolParameters::setPageHeightResults

(

const double &

p

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_pageHeightResults=p;}

void MonoStation::AbstractToolParameters::setPlotCountPerLineResults

(

const int &

p

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters().

{_plotCountPerLineResults=p;}

void MonoStation::AbstractToolParameters::setSampling

(

const SamplingParameters &

s

)

[inline]

{_sampling=s;}

void MonoStation::AbstractToolParameters::setSmoothing

(

const SmoothingParameters &

s

)

[inline]

{_smoothing=s;}

void MonoStation::AbstractToolParameters::setTapering

(

const TaperParameters &

t

)

[inline]

{_tapering=t;}

bool MonoStation::AbstractToolParameters::setValue

(

PARAMETERS_SETVALUE_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References setHorizontal(), and TRACE.

  {
    TRACE;
    switch(index) {
    case 0:
      if(value=="false") {
        _highPassFrequency=0.0;
      }
      return true;
    case 1:
      _highPassFrequency=value.toDouble();
      return true;
    case 2:
      setHorizontal(value);
      return true;
    case 3:
      _horizontalAzimuth=value.toDouble();
      return true;
    default:
      return false;
    }
  }

void MonoStation::AbstractToolParameters::setWindowing

(

const WindowingParameters &

w

)

[inline]

{_windowing=w;}

SmoothingParameters& MonoStation::AbstractToolParameters::smoothing

(

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters(), HVStationSignals::horizontal(), MonoStation::AbstractToold::setParameters(), StructureStationProcessSignals::setProcessed(), HVStationSignals::setProcessed(), and MonoStation::SpectrumStationSignals::setProcessed().

{return _smoothing;}

const SmoothingParameters& MonoStation::AbstractToolParameters::smoothing

(

)

const [inline]

{return _smoothing;}

TaperParameters& MonoStation::AbstractToolParameters::tapering

(

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters(), MonoStation::AbstractToold::setParameters(), StructureStationProcessSignals::setProcessed(), and MonoStation::SpectrumStationSignals::setProcessed().

{return _tapering;}

const TaperParameters& MonoStation::AbstractToolParameters::tapering

(

)

const [inline]

{return _tapering;}

QString MonoStation::AbstractToolParameters::toString

(

PARAMETERS_TOSTRING_ARGS_DECL

)

const [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References horizontalString(), QGpCoreTools::log(), QGpCoreTools::SmoothingParameters::toString(), GeopsyCore::TaperParameters::toString(), QGpCoreTools::SamplingParameters::toString(), GeopsyCore::WindowingParameters::toString(), and TRACE.

  {
    TRACE;
    QString log;
    log+=_windowing.toString(prefix);
    log+=_smoothing.toString(prefix);
    log+=_tapering.toString(prefix);
    log+=_sampling.toString(prefix);
    log+=prefix+"DO HIGH PASS=";
    log+=(_highPassFrequency>0.0 ? "true" : "false");
    log+="\n";
    log+=prefix+"HIGH PASS FREQUENCY="+QString::number(_highPassFrequency)+"\n";
    log+=prefix+"HORIZONTAL COMPONENTS="+horizontalString()+"\n";
    log+=prefix+"HORIZONTAL AZIMUTH="+QString::number(_horizontalAzimuth)+"\n";
    return log;
  }

WindowingParameters& MonoStation::AbstractToolParameters::windowing

(

)

[inline]

Referenced by MonoStation::AbstractToold::getParameters(), and MonoStation::AbstractToold::setParameters().

{return _windowing;}

const WindowingParameters& MonoStation::AbstractToolParameters::windowing

(

)

const [inline]

{return _windowing;}

---

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

• MonoStation/AbstractToolParameters.h
• MonoStation/AbstractToolParameters.cpp