ArrayCore::LinearFKParameters Class Reference

Brief description of class still missing. More...

#include <LinearFKParameters.h>

Inheritance diagram for ArrayCore::LinearFKParameters:

List of all members.

Public Types
enum	BeamPowerNormalization { Raw, Spectrum, Maximum }
enum	YSamplingType { Slowness, Velocity }
Public Member Functions
BeamPowerNormalization	beamPowerNormalization () const
QString	beamPowerNormalizationString () const
virtual void	collectKeywords (PARAMETERS_COLLECTKEYWORDS_ARGS)
double	dampingFactor () const
double	frequencyBandwidth () const
double	frequencySmoothingFactor () const
bool	highResolution () const
virtual int	keywordCount (PARAMETERS_KEYWORDCOUNT_ARGS)
	LinearFKParameters ()
	LinearFKParameters (const LinearFKParameters &o)
double	maximumDistance () const
double	minimumDistance () const
NormalizationParameters &	normalization ()
const NormalizationParameters &	normalization () const
void	setBeamPowerNormalization (const BeamPowerNormalization &b)
void	setBeamPowerNormalization (const QString &b)
void	setDampingFactor (double d)
void	setFrequencyBandwidth (double f)
void	setFrequencySmoothingFactor (double f)
void	setHighResolution (bool hr)
void	setMaximumDistance (double m)
void	setMinimumDistance (double m)
void	setNormalization (const NormalizationParameters &n)
void	setTaper (const TaperParameters &t)
void	setTimeRange (const TimeRangeParameters &t)
virtual bool	setValue (PARAMETERS_SETVALUE_ARGS)
void	setXSampling (const SamplingParameters &x)
void	setYSampling (const SamplingParameters &y)
void	setYSamplingType (YSamplingType t)
void	setYSamplingType (const QString &t)
TaperParameters &	taper ()
const TaperParameters &	taper () const
TimeRangeParameters &	timeRange ()
const TimeRangeParameters &	timeRange () const
virtual QString	toString (PARAMETERS_TOSTRING_ARGS_DECL) const
SamplingParameters &	xSampling ()
const SamplingParameters &	xSampling () const
SamplingParameters &	ySampling ()
const SamplingParameters &	ySampling () const
YSamplingType	ySamplingType () const
QString	ySamplingTypeString () const

---

Detailed Description

Brief description of class still missing.

Full description of class still missing

---

Member Enumeration Documentation

enum ArrayCore::LinearFKParameters::BeamPowerNormalization

Enumerator:

Raw
Spectrum
Maximum

{Raw, Spectrum, Maximum};

enum ArrayCore::LinearFKParameters::YSamplingType

Enumerator:

Slowness
Velocity

{Slowness, Velocity};

---

Constructor & Destructor Documentation

ArrayCore::LinearFKParameters::LinearFKParameters

(

)

Description of constructor still missing

References QGpCoreTools::SamplingParameters::setCount(), QGpCoreTools::SamplingParameters::setRange(), QGpCoreTools::SamplingParameters::setType(), Spectrum, TRACE, and Velocity.

  {
    TRACE;

    _minimumDistance=10.0;
    _maximumDistance=200.0;

    _frequencySmoothingFactor=4;
    _frequencyBandwidth=0.1;
    _highResolution=false;
    _dampingFactor=0.0;

    _xSampling.setCount(100);
    _xSampling.setType(SamplingParameters::Log);
    _xSampling.setRange(10.0, 50.0);

    _ySampling.setCount(500);
    _ySampling.setType(SamplingParameters::Linear);
    _ySampling.setRange(0.001, 0.01);

    _ySamplingType=Velocity;

    _beamPowerNormalization=Spectrum;
  }

ArrayCore::LinearFKParameters::LinearFKParameters

(

const LinearFKParameters &

o

)

References TRACE.

    : AbstractParameters()
  {
    TRACE;
    _minimumDistance=o._minimumDistance;
    _maximumDistance=o._maximumDistance;

    _timeRange=o._timeRange;
    _taper=o._taper;

    _normalization=o._normalization;

    _frequencySmoothingFactor=o._frequencySmoothingFactor;
    _frequencyBandwidth=o._frequencyBandwidth;
    _highResolution=o._highResolution;
    _dampingFactor=o._dampingFactor;

    _xSampling=o._xSampling;
    _ySampling=o._ySampling;

    _ySamplingType=o._ySamplingType;

    _beamPowerNormalization=o._beamPowerNormalization;
  }

---

Member Function Documentation

BeamPowerNormalization ArrayCore::LinearFKParameters::beamPowerNormalization

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _beamPowerNormalization;}

QString ArrayCore::LinearFKParameters::beamPowerNormalizationString

(

)

const

References Maximum, Raw, Spectrum, and TRACE.

Referenced by toString().

  {
    TRACE;
    switch(_beamPowerNormalization) {
    case Raw:
      break;
    case Spectrum:
      return "Spectrum";
    case Maximum:
      return "Maximum";
    }
    return "Raw";
  }

void ArrayCore::LinearFKParameters::collectKeywords

(

PARAMETERS_COLLECTKEYWORDS_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References GeopsyCore::NormalizationParameters::collectKeywords(), GeopsyCore::TaperParameters::collectKeywords(), QGpCoreTools::SamplingParameters::collectKeywords(), GeopsyCore::TimeRangeParameters::collectKeywords(), and TRACE.

  {
    TRACE;
    keywords.add(prefix+"MINIMUM DISTANCE", this, 0);
    keywords.add(prefix+"MAXIMUM DISTANCE", this, 1);
    keywords.add(prefix+"FREQUENCY SMOOTHING", this, 2);
    keywords.add(prefix+"FREQ BANDWIDTH", this, 3);
    keywords.add(prefix+"HIGH RESOLUTION", this, 4);
    keywords.add(prefix+"DAMPING FACTOR", this, 5);
    keywords.add(prefix+"BEAM POWER NORMALIZATION", this, 6);
    keywords.add(prefix+"Y SAMPLING TYPE", this, 7);
    // For compatibility
    keywords.add(prefix+"FREQUENCY BAND WIDTH", this, 2);
    keywords.add(prefix+"DO DAMPING FACTOR", this, 8);
    keywords.add(prefix+"DO TAPER", this, 8);
    keywords.add(prefix+"TAPER WIDTH (%)", this, 8);

    _timeRange.collectKeywords(keywords, prefix);
    _taper.collectKeywords(keywords, prefix);
    _normalization.collectKeywords(keywords, prefix);
    _xSampling.collectKeywords(keywords, prefix+"X ");
    _ySampling.collectKeywords(keywords, prefix+"Y ");
  }

double ArrayCore::LinearFKParameters::dampingFactor

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _dampingFactor;}

double ArrayCore::LinearFKParameters::frequencyBandwidth

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _frequencyBandwidth;}

double ArrayCore::LinearFKParameters::frequencySmoothingFactor

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _frequencySmoothingFactor;}

bool ArrayCore::LinearFKParameters::highResolution

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _highResolution;}

int ArrayCore::LinearFKParameters::keywordCount

(

PARAMETERS_KEYWORDCOUNT_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

  {
    return 9;
  }

double ArrayCore::LinearFKParameters::maximumDistance

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _maximumDistance;}

double ArrayCore::LinearFKParameters::minimumDistance

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _minimumDistance;}

NormalizationParameters& ArrayCore::LinearFKParameters::normalization

(

)

[inline]

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

{return _normalization;}

const NormalizationParameters& ArrayCore::LinearFKParameters::normalization

(

)

const [inline]

{return _normalization;}

void ArrayCore::LinearFKParameters::setBeamPowerNormalization

(

const BeamPowerNormalization &

b

)

[inline]

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

{_beamPowerNormalization=b;}

void ArrayCore::LinearFKParameters::setBeamPowerNormalization

(

const QString &

b

)

References Maximum, Raw, Spectrum, and TRACE.

  {
    TRACE;
    if(b.count()>0) {
      QString bl=b.toLower();
      switch(bl[0].unicode()) {
      case 'r':
        if(bl=="raw") {
          _beamPowerNormalization=Raw;
        }
        break;
      case 's':
        if(bl=="spectrum") {
          _beamPowerNormalization=Spectrum;
        }
        break;
      case 'm':
        if(bl=="maximum") {
          _beamPowerNormalization=Maximum;
        }
        break;
      default:
        break;
      }
    }
  }

void ArrayCore::LinearFKParameters::setDampingFactor

(

double

d

)

[inline]

Referenced by ToolLinearFKActived::getParameters().

{_dampingFactor=d;}

void ArrayCore::LinearFKParameters::setFrequencyBandwidth

(

double

f

)

[inline]

Referenced by ToolLinearFKActived::getParameters().

{_frequencyBandwidth=f;}

void ArrayCore::LinearFKParameters::setFrequencySmoothingFactor

(

double

f

)

[inline]

Referenced by ToolLinearFKActived::getParameters().

{_frequencySmoothingFactor=f;}

void ArrayCore::LinearFKParameters::setHighResolution

(

bool

hr

)

[inline]

Referenced by ToolLinearFKActived::getParameters().

{_highResolution=hr;}

void ArrayCore::LinearFKParameters::setMaximumDistance

(

double

m

)

[inline]

Referenced by ToolLinearFKActived::getParameters().

{_maximumDistance=m;}

void ArrayCore::LinearFKParameters::setMinimumDistance

(

double

m

)

[inline]

Referenced by ToolLinearFKActived::getParameters().

{_minimumDistance=m;}

void ArrayCore::LinearFKParameters::setNormalization

(

const NormalizationParameters &

n

)

[inline]

{_normalization=n;}

void ArrayCore::LinearFKParameters::setTaper

(

const TaperParameters &

t

)

[inline]

{_taper=t;}

void ArrayCore::LinearFKParameters::setTimeRange

(

const TimeRangeParameters &

t

)

[inline]

{_timeRange=t;}

bool ArrayCore::LinearFKParameters::setValue

(

PARAMETERS_SETVALUE_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References setBeamPowerNormalization(), setYSamplingType(), and TRACE.

  {
    TRACE;
    switch(index) {
    case 0:
      _minimumDistance=value.toDouble();
      return true;
    case 1:
      _maximumDistance=value.toDouble();
      return true;
    case 2:
      _frequencySmoothingFactor=value.toDouble();
      return true;
    case 3:
      _frequencyBandwidth=value.toDouble();
      return true;
    case 4:
      _highResolution=(value=="y");
      return true;
    case 5:
      _dampingFactor=value.toDouble();
      return true;
    case 6:
      setYSamplingType(value);
      return true;
    case 7:
      setBeamPowerNormalization(value);
      return true;
    case 8:           // For compatibility, ignore those values
      return true;
    default:
      return false;
    }
  }

void ArrayCore::LinearFKParameters::setXSampling

(

const SamplingParameters &

x

)

[inline]

{_xSampling=x;}

void ArrayCore::LinearFKParameters::setYSampling

(

const SamplingParameters &

y

)

[inline]

{_ySampling=y;}

void ArrayCore::LinearFKParameters::setYSamplingType

(

YSamplingType

t

)

[inline]

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

{_ySamplingType=t;}

void ArrayCore::LinearFKParameters::setYSamplingType

(

const QString &

t

)

References Slowness, TRACE, and Velocity.

  {
    TRACE;
    if(t.count()>0) {
      QString tl=t.toLower();
      switch(tl[0].unicode()) {
      case 's':
        if(tl=="slowness") {
          _ySamplingType=Slowness;
        }
        break;
      case 'v':
        if(tl=="velocity") {
          _ySamplingType=Velocity;
        }
        break;
      default:
        break;
      }
    }
  }

TaperParameters& ArrayCore::LinearFKParameters::taper

(

)

[inline]

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

{return _taper;}

const TaperParameters& ArrayCore::LinearFKParameters::taper

(

)

const [inline]

{return _taper;}

TimeRangeParameters& ArrayCore::LinearFKParameters::timeRange

(

)

[inline]

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

{return _timeRange;}

const TimeRangeParameters& ArrayCore::LinearFKParameters::timeRange

(

)

const [inline]

{return _timeRange;}

QString ArrayCore::LinearFKParameters::toString

(

PARAMETERS_TOSTRING_ARGS_DECL

)

const [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References beamPowerNormalizationString(), QGpCoreTools::log(), GeopsyCore::NormalizationParameters::toString(), GeopsyCore::TaperParameters::toString(), QGpCoreTools::SamplingParameters::toString(), GeopsyCore::TimeRangeParameters::toString(), TRACE, and ySamplingTypeString().

  {
    TRACE;
    QString log;
    log+=prefix+"MINIMUM DISTANCE="+QString::number(_minimumDistance)+"\n";
    log+=prefix+"MAXIMUM DISTANCE="+QString::number(_maximumDistance)+"\n";
    log+=_timeRange.toString(prefix);
    log+=_taper.toString(prefix);
    log+=_normalization.toString(prefix);
    log+=prefix+"FREQUENCY SMOOTHING="+QString::number(_frequencySmoothingFactor)+"\n";
    log+=prefix+"FREQUENCY BANDWIDTH="+QString::number(_frequencyBandwidth)+"\n";
    log+=prefix+"HIGH RESOLUTION="+(_highResolution ? "y" : "n")+"\n";
    log+=prefix+"DAMPING FACTOR="+QString::number(_dampingFactor)+"\n";
    log+=_xSampling.toString(prefix+"X ");
    log+=_ySampling.toString(prefix+"Y ");
    log+=prefix+"Y SAMPLING TYPE="+ySamplingTypeString()+"\n";
    log+=prefix+"BEAM POWER NORMALIZATION="+beamPowerNormalizationString()+"\n";
    return log;
  }

SamplingParameters& ArrayCore::LinearFKParameters::xSampling

(

)

[inline]

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

{return _xSampling;}

const SamplingParameters& ArrayCore::LinearFKParameters::xSampling

(

)

const [inline]

{return _xSampling;}

SamplingParameters& ArrayCore::LinearFKParameters::ySampling

(

)

[inline]

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

{return _ySampling;}

const SamplingParameters& ArrayCore::LinearFKParameters::ySampling

(

)

const [inline]

{return _ySampling;}

YSamplingType ArrayCore::LinearFKParameters::ySamplingType

(

)

const [inline]

Referenced by ToolLinearFKActived::setParameters().

{return _ySamplingType;}

QString ArrayCore::LinearFKParameters::ySamplingTypeString

(

)

const

References Slowness, TRACE, and Velocity.

Referenced by toString().

  {
    TRACE;
    switch(_ySamplingType) {
    case Slowness:
      break;
    case Velocity:
      return "Velocity";
    }
    return "Slowness";
  }

---

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

• ArrayCore/LinearFKParameters.h
• ArrayCore/LinearFKParameters.cpp