An axis sampling definition. More...

#include <SamplingParameters.h>

Inheritance diagram for QGpCoreTools::SamplingParameters:

Public Types
enum	Type { Linear, Log }
Public Member Functions
virtual void	collectKeywords (PARAMETERS_COLLECTKEYWORDS_ARGS)
int	count () const
void	inverse ()
bool	inversed () const
virtual int	keywordCount (PARAMETERS_KEYWORDCOUNT_ARGS)
double	maximum () const
double	minimum () const
void	operator= (const SamplingParameters &o)
	SamplingParameters ()
void	setCount (int n)
void	setInversed (bool i)
void	setRange (double min, double max)
void	setType (Type t)
void	setType (const QString &t)
virtual bool	setValue (PARAMETERS_SETVALUE_ARGS)
virtual QString	toString (PARAMETERS_TOSTRING_ARGS_DECL) const
Type	type () const
QString	typeString () const
double	value (int i) const

Detailed Description

An axis sampling definition.

Full description of class still missing

Member Enumeration Documentation

enum QGpCoreTools::SamplingParameters::Type

Enumerator:

Linear
Log

{Linear,Log};

Constructor & Destructor Documentation

QGpCoreTools::SamplingParameters::SamplingParameters ( )

References Linear, and TRACE.

  {
    TRACE;
    _min=0.0;
    _max=0.0;
    _step=0.0;
    _type=Linear;
    _n=0;
    _inversed=false;
  }

Member Function Documentation

void QGpCoreTools::SamplingParameters::collectKeywords ( PARAMETERS_COLLECTKEYWORDS_ARGS ) [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References TRACE.

Referenced by TFAParameters::collectKeywords(), ArrayCore::ArrayParameters::collectKeywords(), MonoStation::AbstractToolParameters::collectKeywords(), and ArrayCore::LinearFKParameters::collectKeywords().

  {
    TRACE;
    keywords.add(prefix+"MINIMUM", this, 0);
    keywords.add(prefix+"MAXIMUM", this, 1);
    keywords.add(prefix+"SAMPLES NUMBER", this, 2);
    keywords.add(prefix+"SAMPLING TYPE", this, 3);
    keywords.add(prefix+"INVERSED", this, 4);
  }

int QGpCoreTools::SamplingParameters::count ( ) const [inline]

Referenced by TFAResults::compute(), ToolLinearFKPassive::finishPositive(), RealTimeHistogram::init(), ToolFKd::numFreqChanged(), ArrayCore::ArrayProcess::setFrequency(), QGpGuiWave::DispersionLimitLayer::setFrequencySampling(), QGpGuiTools::SamplingParameterWidget::setParameters(), RealTimeArrayManager::setSamplingParameters(), MonoStation::StationResults::setWindows(), SpectrumRotateStation::start(), HVRotateStation::start(), RealTimeArrayManager::start(), ToolSPAC::startLoop(), and ToolFK::startLoop().

{return _n;}

void QGpCoreTools::SamplingParameters::inverse ( )

References TRACE.

Referenced by ToolLinearFKActived::getParameters(), and ToolLinearFKActived::setParameters().

  {
    TRACE;
    double tmp=_min;
    _min=1.0/_max;
    _max=1.0/tmp;
    setStep();
    _inversed=!_inversed;
  }

bool QGpCoreTools::SamplingParameters::inversed ( ) const [inline]

{return _inversed;}

int QGpCoreTools::SamplingParameters::keywordCount ( PARAMETERS_KEYWORDCOUNT_ARGS ) [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

  {
    return 5;
  }

double QGpCoreTools::SamplingParameters::maximum ( ) const [inline]

Referenced by ToolLinearFKActived::getParameters(), GeopsyGui::NormalizationParameterWidget::getParameters(), HVStationSignals::horizontal(), ArrayGui::ArrayResponse::setFrequencySampling(), QGpGuiTools::SamplingParameterWidget::setParameters(), StructureStationProcessSignals::setProcessed(), HVStationSignals::setProcessed(), MonoStation::SpectrumStationSignals::setProcessed(), ToolFK::setTemporaryKmax(), and LinearFKActiveResults::setXAxis().

{return _max;}

double QGpCoreTools::SamplingParameters::minimum ( ) const [inline]

Referenced by ToolLinearFKActived::getParameters(), GeopsyGui::NormalizationParameterWidget::getParameters(), HVStationSignals::horizontal(), ArrayGui::ArrayResponse::setFrequencySampling(), QGpGuiTools::SamplingParameterWidget::setParameters(), StructureStationProcessSignals::setProcessed(), HVStationSignals::setProcessed(), MonoStation::SpectrumStationSignals::setProcessed(), and LinearFKActiveResults::setXAxis().

{return _min;}

void QGpCoreTools::SamplingParameters::operator= ( const SamplingParameters & o )

References TRACE.

  {
    TRACE;
    _min=o._min;
    _max=o._max;
    _step=o._step;
    _n=o._n;
    _type=o._type;
  }

void QGpCoreTools::SamplingParameters::setCount ( int n ) [inline]

Referenced by QGpGuiTools::SamplingParameterWidget::getParameters(), ArrayCore::LinearFKParameters::LinearFKParameters(), ProcessUnit::ProcessUnit(), and WaranGpsWidget::WaranGpsWidget().

{_n=n; setStep();}

void QGpCoreTools::SamplingParameters::setInversed ( bool i ) [inline]

Referenced by QGpGuiTools::SamplingParameterWidget::getParameters().

{_inversed=i;}

void QGpCoreTools::SamplingParameters::setRange	(	double	min,
		double	max
	)		`[inline]`

Referenced by QGpGuiTools::SamplingParameterWidget::getParameters(), ArrayCore::LinearFKParameters::LinearFKParameters(), ProcessUnit::ProcessUnit(), GeopsyGui::NormalizationParameterWidget::setParameters(), and WaranGpsWidget::WaranGpsWidget().

{_min= min; _max=max; setStep();}

void QGpCoreTools::SamplingParameters::setType ( Type t ) [inline]

Referenced by QGpGuiTools::SamplingParameterWidget::getParameters(), ArrayCore::LinearFKParameters::LinearFKParameters(), setValue(), and WaranGpsWidget::WaranGpsWidget().

{_type=t; setStep();}

void QGpCoreTools::SamplingParameters::setType ( const QString & t )

References QGpCoreTools::endl(), Linear, Log, QGpCoreTools::App::stream(), and QGpCoreTools::tr().

  {
    t.toLower();
    if(t=="linear") {
      _type=Linear;
      return;
    } else if(t=="log") {
      _type=Log;
      return;
    }
    App::stream() << tr("Bad sampling type '%1'.").arg(t) << endl;
  }

bool QGpCoreTools::SamplingParameters::setValue ( PARAMETERS_SETVALUE_ARGS ) [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References setType(), and value().

Referenced by ToolSPACd::on_freqScroll_valueChanged(), and ToolFKd::on_freqScroll_valueChanged().

  {
    switch(index) {
    case 0:
      _min=value.toDouble();
      return true;
    case 1:
      _max=value.toDouble();
      return true;
    case 2:
      _n=value.toInt();
      return true;
    case 3:
      setType(value);
      return true;
    case 4:
      _inversed=true;
      return true;
    default:
      return false;
    }
  }

QString QGpCoreTools::SamplingParameters::toString ( PARAMETERS_TOSTRING_ARGS_DECL ) const [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References QGpCoreTools::log(), TRACE, and typeString().

Referenced by TFAParameters::toString(), ArrayCore::ArrayParameters::toString(), MonoStation::AbstractToolParameters::toString(), and ArrayCore::LinearFKParameters::toString().

  {
    TRACE;
    QString log;
    log+=prefix+"MINIMUM="+QString::number(_min)+"\n";
    log+=prefix+"MAXIMUM="+QString::number(_max)+"\n";
    log+=prefix+"SAMPLES NUMBER="+QString::number(_n)+"\n";
    log+=prefix+"SAMPLING TYPE="+typeString()+"\n";
    return log;
  }

Type QGpCoreTools::SamplingParameters::type ( ) const [inline]

Referenced by QGpGuiTools::SamplingParameterWidget::setParameters(), and LinearFKActiveResults::setXAxis().

{return _type;}

QString QGpCoreTools::SamplingParameters::typeString ( ) const

References Linear, and Log.

Referenced by toString().

  {
    switch(_type) {
    case Linear:
      break;
    case Log:
      return "Log";
    }
    return "Linear";
  }

double QGpCoreTools::SamplingParameters::value ( int i ) const

References Linear, and TRACE.

Referenced by TFAResults::compute(), RealTimeArrayManager::createTasks(), RealTimeHistogram::init(), ToolSPACd::on_freqScroll_valueChanged(), ToolFKd::on_freqScroll_valueChanged(), ProcessUnit::setArrayWindowLength(), ArrayCore::ArrayProcess::setFrequency(), QGpGuiWave::DispersionLimitLayer::setFrequencySampling(), ProcessUnit::setHVWindowLength(), setValue(), MonoStation::StationResults::setWindows(), HVRotateStation::start(), SpectrumRotateStation::start(), and RealTimeArrayManager::start().

  {
    TRACE;
    if(_type==Linear)
      return _min + _step * i;
    else {
      if(_n==1) return _min;
      else return _min*pow(_step, (double)i/(double)(_n-1));
    }
  }

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

QGpCoreTools/SamplingParameters.h
QGpCoreTools/SamplingParameters.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation