Store acoustic power values for different frequencies. More...

#include <spectre.h>

Inheritance diagram for OSpectreAbstract:

Public Member Functions
	OSpectreAbstract ()
	Methods. More...

	OSpectreAbstract (TYSpectreForm form)

	OSpectreAbstract (bool isValid, TYSpectreType type, TYSpectreEtat etat, TYSpectreForm form)

virtual OSpectreAbstract &	operator= (const OSpectreAbstract &other)
	operator= More...

virtual bool	operator== (const OSpectreAbstract &other) const
	operator== More...

virtual bool	operator!= (const OSpectreAbstract &other) const
	operator != More...

OSpectreAbstract &	operator+ (const double &valeur) const
	Add a constant value to all the spectrum. More...

OSpectreAbstract &	operator+ (const OSpectreAbstract &spectre) const
	Arithmetic sum of two spectrums in one-third Octave. More...

OSpectreAbstract &	operator- (const OSpectreAbstract &spectre) const
	Arithmetic subtraction of two spectrums in one-third Octave. More...

OSpectreAbstract &	operator* (const OSpectreAbstract &spectre) const
	Multiplication by a Spectre spectrum. More...

OSpectreAbstract &	operator* (const double &coefficient) const
	Multiplication by a double coefficient. More...

OSpectreAbstract &	sumdB (const OSpectreAbstract &spectre) const
	Energetic sum of two spectrums. More...

virtual double *	getTabValReel ()=0
	Get the array of real values - Pure virtual method. More...

virtual const double *	getTabValReel () const =0

virtual OSpectreAbstract *	getConcreteInstance () const =0
	Return an instance of a concrete class of the same type as current. More...

void	setDefaultValue (const double &valeur=TY_SPECTRE_DEFAULT_VALUE)

bool	isValid () const
	Check the spectrum validity. Invalidity is caused by: corrupted data, impossible calculation. More...

void	setValid (const bool &valid=true)

TYSpectreType	getType () const
	Get the spectrum type. More...

void	setType (TYSpectreType type)
	Set the spectrum type. More...

TYSpectreEtat	getEtat () const
	Get the spectrum state. More...

const TYSpectreEtat	getEtat ()

void	setEtat (TYSpectreEtat etat)
	Force the spectrum state (to use carefully ...) More...

TYSpectreForm	getForm () const
	Get the spectrum form. More...

void	setForm (TYSpectreForm form)
	Force the spectrum state (to use carefully ...) More...

unsigned int	getNbValues () const
	Number of values in the spectrum. More...

void	setDefaultValue (double module[], const unsigned int spectreNbElmt=TY_SPECTRE_DEFAULT_NB_ELMT, const double &valeur=TY_SPECTRE_DEFAULT_VALUE)

void	getRangeValueReal (double *valeurs, const short &nbVal, const short &decalage)

OSpectreAbstract &	sum (const OSpectreAbstract &spectre) const
	Arithmetic sum of two spectrums in one-third Octave. More...

OSpectreAbstract &	sum (const double &value) const
	Arithmetic sum of a spectrum and a double scalar. More...

OSpectreAbstract &	mult (const OSpectreAbstract &spectre) const
	Multiplication of two spectrums. More...

OSpectreAbstract &	mult (const double &coefficient) const
	Multiply this spectrum par a double scalar. More...

OSpectreAbstract &	div (const OSpectreAbstract &spectre) const
	Division of two spectrums. More...

OSpectreAbstract &	div (const double &coefficient) const
	Division of this spectrum by a double scalar. More...

OSpectreAbstract &	subst (const OSpectreAbstract &spectre) const
	Arithmetic subtraction of two spectrums in one-third Octave. More...

OSpectreAbstract &	subst (const double &valeur) const
	Subtract a constant value to this spectrum. More...

OSpectreAbstract &	invMult (const double &coefficient=1.0) const
	Division of a double constant by this spectrum. More...

OSpectreAbstract &	inv () const
	Division of one by this spectrum. More...

OSpectreAbstract &	power (const double &puissance) const
	Return a spectrum as this spectrum raised to a double power. More...

OSpectreAbstract &	log (const double &base=10.0) const
	Compute the log base n of this spectrum (n=10 by default). More...

OSpectreAbstract &	racine () const
	Compute the root square of this spectrum. More...

OSpectreAbstract &	exp (const double coef=1.0)
	Compute e^(coef * spectre) of this spectrum. More...

OSpectreAbstract &	sin () const
	Compute the sin of this spectrum. More...

OSpectreAbstract &	cos () const
	Compute the cos of this spectrum. More...

OSpectreAbstract &	abs () const
	Return the absolute value of this spectrum. More...

OSpectreAbstract &	sqrt () const
	Return the root square of a spectrum. More...

double	valMax ()
	Return the maximum value of a spectrum. More...

OSpectreAbstract &	seuillage (const double &min=-200.0, const double max=200.0)
	Limit the spectrum values (min and max) More...

double	sigma ()
	Sum the values of the spectrum. More...

const double	sigma () const

OSpectreAbstract &	toDB () const
	Converts to dB. More...

OSpectreAbstract &	toGPhy () const
	Converts to physical quantity. More...

double	valGlobDBLin () const
	Compute the global value dB[Lin] of a one-third Octave spectrum. More...

double	valGlobDBA () const
	Compute the global value dB[A] of a one-third Octave spectrum. More...

OSpectreAbstract &	toTOct () const
	Converts to one-third Octave. More...

OSpectreAbstract &	toOct () const
	Converts to Octave. More...

OSpectreAbstract &	round ()

virtual void	printme () const
	Print the spectrum. More...

Static Public Member Functions
static OSpectreAbstract &	makeOctSpect ()
	Make a spectrum in Octave. More...

Protected Attributes
bool	_valid
	Spectrum validity. More...

TYSpectreType	_type
	Spectrum type. More...

TYSpectreEtat	_etat
	Spectrum state (physical quantity or dB). More...

TYSpectreForm	_form
	Representation of the spectrum: one-third Octave, Octave, constant delta f, unstructured. More...

Static Protected Attributes
static double	_defaultValue = TY_SPECTRE_DEFAULT_VALUE
	Default value for the spectrum. More...

Detailed Description

Store acoustic power values for different frequencies.

Author: Projet_Tympan

Definition at line 82 of file spectre.h.

Constructor & Destructor Documentation

◆ OSpectreAbstract() [1/3]

OSpectreAbstract::OSpectreAbstract ( )

explicit

Methods.

Constructors

Definition at line 53 of file spectre.cpp.

◆ OSpectreAbstract() [2/3]

OSpectreAbstract::OSpectreAbstract ( TYSpectreForm form )

explicit

Definition at line 58 of file spectre.cpp.

◆ OSpectreAbstract() [3/3]

OSpectreAbstract::OSpectreAbstract	(	bool	isValid,
		TYSpectreType	type,
		TYSpectreEtat	etat,
		TYSpectreForm	form
	)

explicit

Definition at line 63 of file spectre.cpp.

Member Function Documentation

◆ abs()

OSpectreAbstract & OSpectreAbstract::abs ( ) const

Return the absolute value of this spectrum.

Definition at line 498 of file spectre.cpp.

Here is the call graph for this function:

◆ cos()

OSpectreAbstract & OSpectreAbstract::cos ( ) const

Compute the cos of this spectrum.

Definition at line 483 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ div() [1/2]

OSpectreAbstract & OSpectreAbstract::div ( const double & coefficient ) const

Division of this spectrum by a double scalar.

Definition at line 299 of file spectre.cpp.

Here is the call graph for this function:

◆ div() [2/2]

OSpectreAbstract & OSpectreAbstract::div ( const OSpectreAbstract & spectre ) const

Division of two spectrums.

Definition at line 278 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exp()

OSpectreAbstract & OSpectreAbstract::exp ( const double coef = 1.0 )

Compute e^(coef * spectre) of this spectrum.

Definition at line 454 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConcreteInstance()

virtual OSpectreAbstract* OSpectreAbstract::getConcreteInstance ( ) const

pure virtual

Return an instance of a concrete class of the same type as current.

Implemented in OSpectreOctave, and OSpectre.

Here is the caller graph for this function:

◆ getEtat() [1/2]

const TYSpectreEtat OSpectreAbstract::getEtat ( )

inline

Definition at line 163 of file spectre.h.

◆ getEtat() [2/2]

TYSpectreEtat OSpectreAbstract::getEtat ( ) const

inline

Get the spectrum state.

Definition at line 159 of file spectre.h.

Here is the caller graph for this function:

◆ getForm()

TYSpectreForm OSpectreAbstract::getForm ( ) const

inline

Get the spectrum form.

Definition at line 175 of file spectre.h.

Here is the caller graph for this function:

◆ getNbValues()

unsigned int OSpectreAbstract::getNbValues ( ) const

Number of values in the spectrum.

Definition at line 187 of file spectre.cpp.

Here is the caller graph for this function:

◆ getRangeValueReal()

void OSpectreAbstract::getRangeValueReal	(	double *	valeurs,
		const short &	nbVal,
		const short &	decalage
	)

Get an interval of real values from the frequencies/complex array

Parameters

[out]	valeurs	Values array. It should be allocated before.
[in]	nbVal	Number of values to retrieve from the spectrum
[in]	decalage	Index of the first value to retrieve

Definition at line 216 of file spectre.cpp.

Here is the call graph for this function:

◆ getTabValReel() [1/2]

virtual const double* OSpectreAbstract::getTabValReel ( ) const

pure virtual

Implemented in OSpectreOctave, and OSpectre.

◆ getTabValReel() [2/2]

virtual double* OSpectreAbstract::getTabValReel ( )

pure virtual

Get the array of real values - Pure virtual method.

Implemented in OSpectreOctave, and OSpectre.

Here is the caller graph for this function:

◆ getType()

TYSpectreType OSpectreAbstract::getType ( ) const

inline

Get the spectrum type.

Definition at line 148 of file spectre.h.

Here is the caller graph for this function:

◆ inv()

OSpectreAbstract & OSpectreAbstract::inv ( ) const

Division of one by this spectrum.

Definition at line 372 of file spectre.cpp.

Here is the call graph for this function:

◆ invMult()

OSpectreAbstract & OSpectreAbstract::invMult ( const double & coefficient = 1.0 ) const

Division of a double constant by this spectrum.

Definition at line 350 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValid()

bool OSpectreAbstract::isValid ( ) const

inline

Check the spectrum validity. Invalidity is caused by: corrupted data, impossible calculation.

Returns: Spectrum state (valid = true / non valid = false).

Definition at line 134 of file spectre.h.

Here is the caller graph for this function:

◆ log()

OSpectreAbstract & OSpectreAbstract::log ( const double & base = 10.0 ) const

Compute the log base n of this spectrum (n=10 by default).

Definition at line 409 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeOctSpect()

OSpectreAbstract & OSpectreAbstract::makeOctSpect ( )

static

Make a spectrum in Octave.

Definition at line 846 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mult() [1/2]

OSpectreAbstract & OSpectreAbstract::mult ( const double & coefficient ) const

Multiply this spectrum par a double scalar.

Definition at line 262 of file spectre.cpp.

Here is the call graph for this function:

◆ mult() [2/2]

OSpectreAbstract & OSpectreAbstract::mult ( const OSpectreAbstract & spectre ) const

Multiplication of two spectrums.

Definition at line 248 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

bool OSpectreAbstract::operator!= ( const OSpectreAbstract & other ) const

virtual

operator !=

Definition at line 104 of file spectre.cpp.

Here is the call graph for this function:

◆ operator*() [1/2]

OSpectreAbstract & OSpectreAbstract::operator* ( const double & coefficient ) const

Multiplication by a double coefficient.

Definition at line 162 of file spectre.cpp.

Here is the call graph for this function:

◆ operator*() [2/2]

OSpectreAbstract & OSpectreAbstract::operator* ( const OSpectreAbstract & spectre ) const

Multiplication by a Spectre spectrum.

Definition at line 149 of file spectre.cpp.

Here is the call graph for this function:

◆ operator+() [1/2]

OSpectreAbstract & OSpectreAbstract::operator+ ( const double & valeur ) const

Add a constant value to all the spectrum.

Definition at line 109 of file spectre.cpp.

Here is the call graph for this function:

◆ operator+() [2/2]

OSpectreAbstract & OSpectreAbstract::operator+ ( const OSpectreAbstract & spectre ) const

Arithmetic sum of two spectrums in one-third Octave.

Definition at line 123 of file spectre.cpp.

Here is the call graph for this function:

◆ operator-()

OSpectreAbstract & OSpectreAbstract::operator- ( const OSpectreAbstract & spectre ) const

Arithmetic subtraction of two spectrums in one-third Octave.

Definition at line 136 of file spectre.cpp.

Here is the call graph for this function:

◆ operator=()

OSpectreAbstract & OSpectreAbstract::operator= ( const OSpectreAbstract & other )

virtual

operator=

Reimplemented in OSpectreOctave, OSpectreComplex, OSpectre, and TYSpectre.

Definition at line 68 of file spectre.cpp.

Here is the caller graph for this function:

◆ operator==()

bool OSpectreAbstract::operator== ( const OSpectreAbstract & other ) const

virtual

operator==

Definition at line 80 of file spectre.cpp.

Here is the caller graph for this function:

◆ power()

OSpectreAbstract & OSpectreAbstract::power ( const double & puissance ) const

Return a spectrum as this spectrum raised to a double power.

Definition at line 394 of file spectre.cpp.

Here is the call graph for this function:

◆ printme()

void OSpectreAbstract::printme ( ) const

virtual

Print the spectrum.

Definition at line 836 of file spectre.cpp.

Here is the call graph for this function:

◆ racine()

OSpectreAbstract & OSpectreAbstract::racine ( ) const

Compute the root square of this spectrum.

Definition at line 432 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ round()

OSpectreAbstract & OSpectreAbstract::round ( )

Rounds the spectrum values to two digits.

This method is used to round Lw spectrum values to avoid precision issues when testing 17534-3 conformity.

Definition at line 578 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultValue() [1/2]

void OSpectreAbstract::setDefaultValue ( const double & valeur = TY_SPECTRE_DEFAULT_VALUE )

Initialize a spectrum to a default value.

Parameters

valeur Value by default.

Definition at line 202 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultValue() [2/2]

void OSpectreAbstract::setDefaultValue	(	double	module[],
		const unsigned int	spectreNbElmt = `TY_SPECTRE_DEFAULT_NB_ELMT`,
		const double &	valeur = `TY_SPECTRE_DEFAULT_VALUE`
	)

Definition at line 207 of file spectre.cpp.

◆ setEtat()

void OSpectreAbstract::setEtat ( TYSpectreEtat etat )

inline

Force the spectrum state (to use carefully ...)

Definition at line 169 of file spectre.h.

Here is the caller graph for this function:

◆ setForm()

void OSpectreAbstract::setForm ( TYSpectreForm form )

inline

Force the spectrum state (to use carefully ...)

Definition at line 181 of file spectre.h.

Here is the caller graph for this function:

◆ setType()

void OSpectreAbstract::setType ( TYSpectreType type )

inline

Set the spectrum type.

Definition at line 153 of file spectre.h.

Here is the caller graph for this function:

◆ setValid()

void OSpectreAbstract::setValid ( const bool & valid = true )

inline

Force the validity state of the spectrum.

Definition at line 142 of file spectre.h.

Here is the caller graph for this function:

◆ seuillage()

OSpectreAbstract & OSpectreAbstract::seuillage	(	const double &	min = `-200.0`,
		const double	max = `200.0`
	)

Limit the spectrum values (min and max)

Definition at line 537 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigma() [1/2]

double OSpectreAbstract::sigma ( )

Sum the values of the spectrum.

Definition at line 558 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigma() [2/2]

const double OSpectreAbstract::sigma ( ) const

Definition at line 568 of file spectre.cpp.

Here is the call graph for this function:

◆ sin()

OSpectreAbstract & OSpectreAbstract::sin ( ) const

Compute the sin of this spectrum.

Definition at line 469 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sqrt()

OSpectreAbstract & OSpectreAbstract::sqrt ( ) const

Return the root square of a spectrum.

Definition at line 512 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subst() [1/2]

OSpectreAbstract & OSpectreAbstract::subst ( const double & valeur ) const

Subtract a constant value to this spectrum.

Definition at line 335 of file spectre.cpp.

Here is the call graph for this function:

◆ subst() [2/2]

OSpectreAbstract & OSpectreAbstract::subst ( const OSpectreAbstract & spectre ) const

Arithmetic subtraction of two spectrums in one-third Octave.

Definition at line 321 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sum() [1/2]

OSpectreAbstract & OSpectreAbstract::sum ( const double & value ) const

Arithmetic sum of a spectrum and a double scalar.

Definition at line 239 of file spectre.cpp.

Here is the call graph for this function:

◆ sum() [2/2]

OSpectreAbstract & OSpectreAbstract::sum ( const OSpectreAbstract & spectre ) const

Arithmetic sum of two spectrums in one-third Octave.

Definition at line 224 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sumdB()

OSpectreAbstract & OSpectreAbstract::sumdB ( const OSpectreAbstract & spectre ) const

Energetic sum of two spectrums.

Definition at line 176 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toDB()

OSpectreAbstract & OSpectreAbstract::toDB ( ) const

Converts to dB.

Definition at line 595 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toGPhy()

OSpectreAbstract & OSpectreAbstract::toGPhy ( ) const

Converts to physical quantity.

Definition at line 641 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toOct()

OSpectreAbstract & OSpectreAbstract::toOct ( ) const

Converts to Octave.

Definition at line 782 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toTOct()

OSpectreAbstract & OSpectreAbstract::toTOct ( ) const

Converts to one-third Octave.

Definition at line 708 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valGlobDBA()

double OSpectreAbstract::valGlobDBA ( ) const

Compute the global value dB[A] of a one-third Octave spectrum.

Definition at line 690 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valGlobDBLin()

double OSpectreAbstract::valGlobDBLin ( ) const

Compute the global value dB[Lin] of a one-third Octave spectrum.

Definition at line 678 of file spectre.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valMax()

double OSpectreAbstract::valMax ( )

Return the maximum value of a spectrum.

Definition at line 527 of file spectre.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _defaultValue

double OSpectreAbstract::_defaultValue = TY_SPECTRE_DEFAULT_VALUE

staticprotected

Default value for the spectrum.

Definition at line 308 of file spectre.h.

◆ _etat

TYSpectreEtat OSpectreAbstract::_etat

protected

Spectrum state (physical quantity or dB).

Definition at line 319 of file spectre.h.

◆ _form

TYSpectreForm OSpectreAbstract::_form

protected

Representation of the spectrum: one-third Octave, Octave, constant delta f, unstructured.

Definition at line 322 of file spectre.h.

◆ _type

TYSpectreType OSpectreAbstract::_type

protected

Spectrum type.

Definition at line 316 of file spectre.h.

◆ _valid

bool OSpectreAbstract::_valid

protected

Spectrum validity.

Definition at line 313 of file spectre.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_647/Tympan/models/common/spectre.h
/home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_647/Tympan/models/common/spectre.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OSpectreAbstract() [1/3]

◆ OSpectreAbstract() [2/3]

◆ OSpectreAbstract() [3/3]

Member Function Documentation

◆ abs()

◆ cos()

◆ div() [1/2]

◆ div() [2/2]

◆ exp()

◆ getConcreteInstance()

◆ getEtat() [1/2]

◆ getEtat() [2/2]

◆ getForm()

◆ getNbValues()

◆ getRangeValueReal()

◆ getTabValReel() [1/2]

◆ getTabValReel() [2/2]

◆ getType()

◆ inv()

◆ invMult()

◆ isValid()

◆ log()

◆ makeOctSpect()

◆ mult() [1/2]

◆ mult() [2/2]

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator-()

◆ operator=()

◆ operator==()

◆ power()

◆ printme()

◆ racine()

◆ round()

◆ setDefaultValue() [1/2]

◆ setDefaultValue() [2/2]

◆ setEtat()

◆ setForm()

◆ setType()

◆ setValid()

◆ seuillage()

◆ sigma() [1/2]

◆ sigma() [2/2]

◆ sin()

◆ sqrt()

◆ subst() [1/2]

◆ subst() [2/2]

◆ sum() [1/2]

◆ sum() [2/2]

◆ sumdB()

◆ toDB()

◆ toGPhy()

◆ toOct()

◆ toTOct()

◆ valGlobDBA()

◆ valGlobDBLin()

◆ valMax()

Member Data Documentation

◆ _defaultValue

◆ _etat

◆ _form

◆ _type

◆ _valid