General Purpose Geodetic Library
SgParameter Class Reference

#include <SgParameter.h>

Inheritance diagram for SgParameter:
SgPartial SgAttribute

Public Types

enum  Attributes { Attr_IS_SOLVED = 1<<5 , Attr_AUX_FLAG = 1<<6 }
 
- Public Types inherited from SgPartial
enum  Attributes {
  Attr_IS_BREAK = 1<<0 , Attr_IS_PROPAGATED = 1<<1 , Attr_IS_IN_RUN = 1<<2 , Attr_IS_PARTIAL_SET = 1<<3 ,
  Attr_IS_SPECIAL = 1<<4
}
 
enum  DataDomain { DD_OFFSET = 0 , DD_RATE = 1 }
 

Public Member Functions

 SgParameter ()
 
 SgParameter (const SgParameter &p)
 
 SgParameter (const QString &name)
 
 ~SgParameter ()
 
SgParameteroperator= (const SgParameter &a)
 
double getValue () const
 
double getSolution () const
 
double getSigma () const
 
double getScale () const
 
SgParameterCfg::PMode getPMode () const
 
SgParameterCfg::SType getSType () const
 
double getSigmaAPriori () const
 
double getSigmaAPrioriAux () const
 
double getTau () const
 
double getPsd_RWN () const
 
double getPsd_BN () const
 
const QString & getPrefix () const
 
double getStep () const
 
double getTTL () const
 
int getNumOfPolynomials () const
 
SgMJD getTLeft () const
 
SgMJD getTRight () const
 
int getIdx () const
 
void setValue (double v)
 
void setSolution (double v)
 
void setSigma (double v)
 
void setScale (double v)
 
void setPMode (SgParameterCfg::PMode mode)
 
void setSType (SgParameterCfg::SType type)
 
void setSigmaAPriori (double v)
 
void setSigmaAPrioriAux (double v)
 
void setTau (double v)
 
void setPsd_RWN (double v)
 
void setPsd_BN (double v)
 
void setPrefix (const QString &prefix)
 
void setStep (double step)
 
void setTTL (double ttl)
 
void setNumOfPolynomials (int)
 
void setTLeft (const SgMJD &t)
 
void setTRight (const SgMJD &t)
 
void setIdx (int idx)
 
void tune (const SgParameterCfg &)
 
void tune (SgParameterCfg::PMode, const SgParameterCfg &)
 
void tune (const SgParameter &)
 
void resetStatistics ()
 
void decreaseTTL (double)
 
void resetTTL ()
 
void update (SgParameter *p)
 
double calcM (double)
 
double calcRW (double)
 
- Public Member Functions inherited from SgPartial
 SgPartial ()
 
 SgPartial (const SgPartial &p)
 
 SgPartial (const QString &name)
 
 ~SgPartial ()
 
SgPartialoperator= (const SgPartial &a)
 
const QString & getName () const
 
DataDomain getDataDomain () const
 
double getD () const
 
int getNumObs () const
 
int getNumSes () const
 
const SgMJDgetTStart () const
 
const SgMJDgetTFinis () const
 
const SgMJDgetTCurrent () const
 
void setName (const QString &name)
 
void setD (double d)
 
void setDataDomain (DataDomain domain)
 
void setNumObs (int n)
 
void setNumSes (int n)
 
void setTStart (const SgMJD &t)
 
void setTFinis (const SgMJD &t)
 
void resetStatistics ()
 
void updateStatistics (const SgMJD &t, double weight)
 
void zerofy ()
 
SgMJD getTMean (const SgMJD &=tZero) const
 
- Public Member Functions inherited from SgAttribute
 SgAttribute ()
 
 SgAttribute (const SgAttribute &a)
 
 ~SgAttribute ()
 
SgAttributeoperator= (const SgAttribute &a)
 
unsigned int getAttributes () const
 
void setAttributes (unsigned int a)
 
void addAttr (uint a)
 
void delAttr (uint a)
 
void assignAttr (uint a, bool b)
 
void xorAttr (uint a)
 
bool isAttr (uint a) const
 
void clearAll ()
 

Static Public Member Functions

static const QString className ()
 
- Static Public Member Functions inherited from SgPartial
static const QString className ()
 
- Static Public Member Functions inherited from SgAttribute
static const QString className ()
 

Protected Attributes

double value_
 the value of adjustment process (cumulative); More...
 
double solution_
 a solution from latest estimation; More...
 
double sigma_
 a sigma of the latest estimation; More...
 
double scale_
 a scale factor; More...
 
SgParameterCfg::PMode pMode_
 
SgParameterCfg::SType sType_
 
double sigmaAPriori_
 a priori std. deviation (to init the Inform. matrix) More...
 
double sigmaAPrioriAux_
 a priori std. deviation (to init the Inform. matrix) More...
 
double tau_
 time of relaxation (for stochastic parameters) More...
 
double psd_RWN_
 PSD of Ruled White Noise. More...
 
double psd_BN_
 PSD of White Noise used in break. More...
 
QString prefix_
 
double step_
 
double ttl_
 
int numOfPolynomials_
 number of polinomials for a model More...
 
SgMJD tLeft_
 
SgMJD tRight_
 
int idx_
 an index in common list of parameters More...
 

Detailed Description

SgParamater – a parameter to estimate. ====================================================================================================

Definition at line 47 of file SgParameter.h.

Member Enumeration Documentation

◆ Attributes

Enumerator
Attr_IS_SOLVED 

for estimator use

Attr_AUX_FLAG 

for external use

Definition at line 50 of file SgParameter.h.

Constructor & Destructor Documentation

◆ SgParameter() [1/3]

SgParameter::SgParameter ( )
inline

◆ SgParameter() [2/3]

SgParameter::SgParameter ( const SgParameter p)
inline

◆ SgParameter() [3/3]

SgParameter::SgParameter ( const QString &  name)
inline

A constructor. Creates a default object with a name.

Parameters
name– a name.

Definition at line 363 of file SgParameter.h.

References idx_, numOfPolynomials_, SgParameterCfg::PM_NONE, pMode_, prefix_, psd_BN_, psd_RWN_, scale_, sigma_, sigmaAPriori_, sigmaAPrioriAux_, solution_, SgParameterCfg::ST_RANDWALK, step_, sType_, tau_, ttl_, and value_.

◆ ~SgParameter()

SgParameter::~SgParameter ( )
inline

A destructor. Frees allocated memory.

Definition at line 415 of file SgParameter.h.

Member Function Documentation

◆ calcM()

◆ calcRW()

◆ className()

const QString SgParameter::className ( )
static

Returns name of the class (for debug output).

Definition at line 37 of file SgParameter.cpp.

Referenced by calcRW(), and update().

◆ decreaseTTL()

void SgParameter::decreaseTTL ( double  dt)
inline

Definition at line 729 of file SgParameter.h.

References ttl_.

◆ getIdx()

◆ getNumOfPolynomials()

int SgParameter::getNumOfPolynomials ( ) const
inline

◆ getPMode()

◆ getPrefix()

const QString & SgParameter::getPrefix ( ) const
inline

Returns a prefix for the parameter.

Definition at line 515 of file SgParameter.h.

References prefix_.

Referenced by SgParameter(), operator=(), and tune().

◆ getPsd_BN()

double SgParameter::getPsd_BN ( ) const
inline

Returns a PSD for break event for the parameter (means only for stochastic parameters).

Definition at line 507 of file SgParameter.h.

References psd_BN_.

Referenced by SgParameter(), operator=(), and tune().

◆ getPsd_RWN()

double SgParameter::getPsd_RWN ( ) const
inline

Returns a PSD for ruled white noise for the parameter (means only for stochastic parameters).

Definition at line 499 of file SgParameter.h.

References psd_RWN_.

Referenced by SgParameter(), operator=(), and tune().

◆ getScale()

double SgParameter::getScale ( ) const
inline

Returns a scale for the parameter.

Definition at line 451 of file SgParameter.h.

References scale_.

Referenced by SgParameter(), operator=(), reportParameterList(), and tune().

◆ getSigma()

◆ getSigmaAPriori()

double SgParameter::getSigmaAPriori ( ) const
inline

◆ getSigmaAPrioriAux()

double SgParameter::getSigmaAPrioriAux ( ) const
inline

◆ getSolution()

◆ getStep()

double SgParameter::getStep ( ) const
inline

Returns a value of the step for modelling by picewise linear function.

Definition at line 523 of file SgParameter.h.

References step_.

Referenced by SgParameter(), SgArcStorage::deployParameters(), SgPwlStorageBSplineL::deployParameters(), SgPwlStorageBSplineQ::deployParameters(), SgPwlStorageIncRates::deployParameters(), operator=(), and tune().

◆ getSType()

SgParameterCfg::SType SgParameter::getSType ( ) const
inline

Returns a type of stochastic parameter (means only for stochastic parameters).

Definition at line 467 of file SgParameter.h.

References sType_.

Referenced by SgParameter(), operator=(), and tune().

◆ getTau()

double SgParameter::getTau ( ) const
inline

Returns a time constant for the parameter (means only for stochastic parameters).

Definition at line 491 of file SgParameter.h.

References tau_.

Referenced by SgParameter(), operator=(), and tune().

◆ getTLeft()

◆ getTRight()

◆ getTTL()

double SgParameter::getTTL ( ) const
inline

Returns a value of the time-to-live (days).

Definition at line 531 of file SgParameter.h.

References ttl_.

Referenced by SgParameter(), lessThan4_ParameterByTTLSortingOrder(), operator=(), and tune().

◆ getValue()

double SgParameter::getValue ( ) const
inline

Returns a value of the parameter.

Definition at line 427 of file SgParameter.h.

References value_.

Referenced by SgParameter(), and operator=().

◆ operator=()

◆ resetStatistics()

void SgParameter::resetStatistics ( )
inline

Clears values.

Definition at line 719 of file SgParameter.h.

References SgPartial::resetStatistics(), sigma_, solution_, and value_.

◆ resetTTL()

void SgParameter::resetTTL ( )
inline

Definition at line 737 of file SgParameter.h.

References step_, and ttl_.

◆ setIdx()

void SgParameter::setIdx ( int  idx)
inline

Definition at line 707 of file SgParameter.h.

References idx_.

Referenced by SgEstimator::prepare2Run().

◆ setNumOfPolynomials()

void SgParameter::setNumOfPolynomials ( int  n)
inline

Set up a value of a number of polinomials.

Definition at line 683 of file SgParameter.h.

References numOfPolynomials_.

Referenced by SgTaskManager::fillParameterList().

◆ setPMode()

void SgParameter::setPMode ( SgParameterCfg::PMode  mode)
inline

◆ setPrefix()

void SgParameter::setPrefix ( const QString &  prefix)
inline

Sets up a prefix for the parameter.

Parameters
prefix– a prefix;

Definition at line 659 of file SgParameter.h.

References prefix_.

◆ setPsd_BN()

void SgParameter::setPsd_BN ( double  v)
inline

Sets up a PSD for break event for the parameter (means only for stochastic parameters).

Parameters
v– a new PSD;

Definition at line 651 of file SgParameter.h.

References psd_BN_.

◆ setPsd_RWN()

void SgParameter::setPsd_RWN ( double  v)
inline

Sets up a PSD for ruled white noise for the parameter (means only for stochastic parameters).

Parameters
v– a new PSD;

Definition at line 643 of file SgParameter.h.

References psd_RWN_.

◆ setScale()

void SgParameter::setScale ( double  v)
inline

Sets up a scale for the parameter.

Parameters
v– a scale;

Definition at line 595 of file SgParameter.h.

References scale_.

Referenced by SgSolutionReporter::evaluateUsedErpApriori().

◆ setSigma()

void SgParameter::setSigma ( double  v)
inline

◆ setSigmaAPriori()

◆ setSigmaAPrioriAux()

void SgParameter::setSigmaAPrioriAux ( double  v)
inline

Sets up an a priori sigma for the parameter.

Parameters
v– an a priori;

Definition at line 627 of file SgParameter.h.

References sigmaAPrioriAux_.

◆ setSolution()

void SgParameter::setSolution ( double  v)
inline

◆ setStep()

void SgParameter::setStep ( double  step)
inline

Sets up a value of the step for modelling by picewise linear function.

Parameters
s– new step;

Definition at line 667 of file SgParameter.h.

References step_.

◆ setSType()

void SgParameter::setSType ( SgParameterCfg::SType  type)
inline

Sets up a type of stochastic parameter (means only for stochastic parameters).

Parameters
type– a new type;

Definition at line 611 of file SgParameter.h.

References sType_.

◆ setTau()

void SgParameter::setTau ( double  v)
inline

Sets up a time constant for the parameter (means only for stochastic parameters).

Parameters
v– a new tau;

Definition at line 635 of file SgParameter.h.

References tau_.

◆ setTLeft()

void SgParameter::setTLeft ( const SgMJD t)
inline

◆ setTRight()

void SgParameter::setTRight ( const SgMJD t)
inline

◆ setTTL()

void SgParameter::setTTL ( double  ttl)
inline

Sets up a value of the time-to-live (days).

Definition at line 675 of file SgParameter.h.

References ttl_.

◆ setValue()

void SgParameter::setValue ( double  v)
inline

Sets up a value of the parameter.

Parameters
v– a value;

Definition at line 571 of file SgParameter.h.

References value_.

◆ tune() [1/3]

◆ tune() [2/3]

◆ tune() [3/3]

◆ update()

void SgParameter::update ( SgParameter p)

Updates values from the solution.

Definition at line 178 of file SgParameter.cpp.

References className(), SgLogger::ERR, SgLogger::ESTIMATOR, getSigma(), getSolution(), logger, sigma_, solution_, value_, and SgLogger::write().

Member Data Documentation

◆ idx_

int SgParameter::idx_
protected

an index in common list of parameters

Definition at line 316 of file SgParameter.h.

Referenced by SgParameter(), getIdx(), operator=(), and setIdx().

◆ numOfPolynomials_

int SgParameter::numOfPolynomials_
protected

number of polinomials for a model

Definition at line 312 of file SgParameter.h.

Referenced by SgParameter(), getNumOfPolynomials(), operator=(), setNumOfPolynomials(), and tune().

◆ pMode_

SgParameterCfg::PMode SgParameter::pMode_
protected

Definition at line 302 of file SgParameter.h.

Referenced by SgParameter(), getPMode(), operator=(), setPMode(), and tune().

◆ prefix_

QString SgParameter::prefix_
protected

Definition at line 309 of file SgParameter.h.

Referenced by SgParameter(), getPrefix(), operator=(), setPrefix(), and tune().

◆ psd_BN_

double SgParameter::psd_BN_
protected

PSD of White Noise used in break.

Definition at line 308 of file SgParameter.h.

Referenced by SgParameter(), calcRW(), getPsd_BN(), operator=(), setPsd_BN(), and tune().

◆ psd_RWN_

double SgParameter::psd_RWN_
protected

PSD of Ruled White Noise.

Definition at line 307 of file SgParameter.h.

Referenced by SgParameter(), calcRW(), getPsd_RWN(), operator=(), setPsd_RWN(), and tune().

◆ scale_

double SgParameter::scale_
protected

a scale factor;

Definition at line 300 of file SgParameter.h.

Referenced by SgParameter(), getScale(), operator=(), setScale(), and tune().

◆ sigma_

double SgParameter::sigma_
protected

a sigma of the latest estimation;

Definition at line 299 of file SgParameter.h.

Referenced by SgParameter(), getSigma(), operator=(), resetStatistics(), setSigma(), and update().

◆ sigmaAPriori_

double SgParameter::sigmaAPriori_
protected

a priori std. deviation (to init the Inform. matrix)

Definition at line 304 of file SgParameter.h.

Referenced by SgParameter(), calcRW(), getSigmaAPriori(), operator=(), setSigmaAPriori(), and tune().

◆ sigmaAPrioriAux_

double SgParameter::sigmaAPrioriAux_
protected

a priori std. deviation (to init the Inform. matrix)

Definition at line 305 of file SgParameter.h.

Referenced by SgParameter(), getSigmaAPrioriAux(), operator=(), setSigmaAPrioriAux(), and tune().

◆ solution_

double SgParameter::solution_
protected

a solution from latest estimation;

Definition at line 298 of file SgParameter.h.

Referenced by SgParameter(), getSolution(), operator=(), resetStatistics(), setSolution(), and update().

◆ step_

double SgParameter::step_
protected

Definition at line 310 of file SgParameter.h.

Referenced by SgParameter(), getStep(), operator=(), resetTTL(), setStep(), and tune().

◆ sType_

SgParameterCfg::SType SgParameter::sType_
protected

Definition at line 303 of file SgParameter.h.

Referenced by SgParameter(), calcM(), calcRW(), getSType(), operator=(), setSType(), and tune().

◆ tau_

double SgParameter::tau_
protected

time of relaxation (for stochastic parameters)

Definition at line 306 of file SgParameter.h.

Referenced by SgParameter(), calcM(), calcRW(), getTau(), operator=(), setTau(), and tune().

◆ tLeft_

SgMJD SgParameter::tLeft_
protected

Definition at line 314 of file SgParameter.h.

Referenced by getTLeft(), operator=(), and setTLeft().

◆ tRight_

SgMJD SgParameter::tRight_
protected

Definition at line 315 of file SgParameter.h.

Referenced by getTRight(), operator=(), and setTRight().

◆ ttl_

double SgParameter::ttl_
protected

Definition at line 311 of file SgParameter.h.

Referenced by SgParameter(), decreaseTTL(), getTTL(), operator=(), resetTTL(), setTTL(), and tune().

◆ value_

double SgParameter::value_
protected

the value of adjustment process (cumulative);

Definition at line 297 of file SgParameter.h.

Referenced by SgParameter(), getValue(), operator=(), resetStatistics(), setValue(), and update().


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