SOFUS ..
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
AperturePulses< T > Class Template Reference

#include <sofus_pulses.hpp>

Public Member Functions

void DeltaPulseSet (const T &RT)
 
void GaussPulseSet (const T &fs, const T &f0, const T &bw)
 
void ToneBurstSet (const T &fs, const T &f0, const size_t &nCycles)
 
 AperturePulses ()
 
 ~AperturePulses ()=default
 
int TemporalPulseGet (const TransmissionType &transmissionType, sps::msignal1D< T > *temporal, T *factor) const
 
void BandWidthSet (const T &value)
 
void FsSet (const T &fs)
 

Static Public Member Functions

static void InPlaceScale (bool enable=false)
 
static void TemporalPulseCalc (const AperturePulses< T > *pXmtPulse, const AperturePulses< T > *pRcvPulse, sps::msignal1D< T > *temporal, T *factor)
 

Public Attributes

ImpulseType m_impulseType
 Parametric or non-parametric impulse. More...
 
ExcitationType m_excitationType
 Parametric or non-parametric excitation. More...
 
size_t m_nCycles
 Number of excitation cycles at f0. More...
 
m_fs
 Sampling frequency. More...
 
m_f0
 Center frequency. More...
 
m_impulseBandwidth
 Bandwidth of temporal response. More...
 
sps::msignal1D< T > excitation
 Excitation. More...
 
sps::msignal1D< T > impulse
 Temporal impulse response of transducer. More...
 

Static Public Attributes

static const T temporalReferenceLevel
 
static const T bandWidthReferenceLevel
 
static bool bInPlaceScale
 

Constructor & Destructor Documentation

◆ AperturePulses()

Default ctor

Returns

◆ ~AperturePulses()

~AperturePulses ( )
default

Default dtor

Returns

Member Function Documentation

◆ BandWidthSet()

void BandWidthSet ( const T &  value)

◆ DeltaPulseSet()

void DeltaPulseSet ( const T &  RT)

◆ FsSet()

void FsSet ( const T &  fs)

◆ GaussPulseSet()

void GaussPulseSet ( const T &  fs,
const T &  f0,
const T &  bw 
)

Set the temporal transducer response to a Gaussian pulse

Parameters
fs
f0
bw

◆ InPlaceScale()

static void InPlaceScale ( bool  enable = false)
static
Todo:
(JEM): Avoid statics

◆ TemporalPulseCalc()

static void TemporalPulseCalc ( const AperturePulses< T > *  pXmtPulse,
const AperturePulses< T > *  pRcvPulse,
sps::msignal1D< T > *  temporal,
T *  factor 
)
static

Compute temporal pulse for time-domain simulations. The returned temporal response and scaling is the convolution and product of TemporalPulseGet applied to each of the pulse objects.

Parameters
pXmtPulsePulse object for transmitting aperture
pRcvPulsePulse object for receiving aperture
temporalTemporal response sampled at fs
factorScale factor to avoid convolution of scalars

◆ TemporalPulseGet()

int TemporalPulseGet ( const TransmissionType transmissionType,
sps::msignal1D< T > *  temporal,
T *  factor 
) const

Compute temporal signal and possible scaling factor.

Parameters
transmissionTypeTransmit or Receive aperture
temporalTemporal response, convolution of impulse and excitation (if transmit).
factorScaling factor (avoid convolutions with scalars)
Returns
Error code

◆ ToneBurstSet()

void ToneBurstSet ( const T &  fs,
const T &  f0,
const size_t &  nCycles 
)
Todo:
: Consider introducing object, which can be parametric or non-parametric

Member Data Documentation

◆ bandWidthReferenceLevel

const T bandWidthReferenceLevel
static

Bandwidth reference level, -6 dB

◆ bInPlaceScale

bool bInPlaceScale
static
Todo:
(JEM): Avoid statics

◆ excitation

sps::msignal1D<T> excitation

Excitation.

◆ impulse

sps::msignal1D<T> impulse

Temporal impulse response of transducer.

◆ m_excitationType

ExcitationType m_excitationType

Parametric or non-parametric excitation.

◆ m_f0

T m_f0

Center frequency.

◆ m_fs

T m_fs

Sampling frequency.

◆ m_impulseBandwidth

T m_impulseBandwidth

Bandwidth of temporal response.

◆ m_impulseType

ImpulseType m_impulseType

Parametric or non-parametric impulse.

◆ m_nCycles

size_t m_nCycles

Number of excitation cycles at f0.

◆ temporalReferenceLevel

const T temporalReferenceLevel
static

Reference level used for temporal responses


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