UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
sim::RickerImpulse Class Reference

#include <sim_impulse.hpp>

Inheritance diagram for sim::RickerImpulse:
sim::Impulse

Public Member Functions

 RickerImpulse (const FreqT &i_w, const AmplT &gain=1.)
 
virtual Impulseclone () const
 
FreqT w () const
 
virtual AmplT operator() (const TimeT &t) const
 
virtual ImpulseType type () const
 
- Public Member Functions inherited from sim::Impulse
 Impulse (const AmplT &gain=1.)
 
virtual void setGain (const AmplT &gain)
 
virtual const AmplT & gain () const
 

Additional Inherited Members

- Protected Attributes inherited from sim::Impulse
AmplT m_gain
 

Detailed Description

Ricker impulse.

Constructor & Destructor Documentation

sim::RickerImpulse::RickerImpulse ( const FreqT &  i_w,
const AmplT &  gain = 1. 
)
inline
Construct Ricker impulse.
Parameters
i_w- frequency in (Hz).

Member Function Documentation

virtual Impulse* sim::RickerImpulse::clone ( ) const
virtual
Clone the object. 
Returns
new pointer to Impulse, should be deleted.

Implements sim::Impulse.

virtual AmplT sim::RickerImpulse::operator() ( const TimeT &  t) const
virtual
Calculates impulse for provided time. 
Parameters
t- time in (ms).

Implements sim::Impulse.

virtual ImpulseType sim::RickerImpulse::type ( ) const
inlinevirtual
Type of the impulse. 
Returns
this impulse type

Implements sim::Impulse.


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