ImFusion C++ SDK 4.5.0
ImFusion::US::GPU::IqDemodulation Class Reference

#include <ImFusion/USImgFormation/CUDA/IqDemodulation.h>

Perform IQ demodulation on an image, performed in CUDA. More...

Detailed Description

Perform IQ demodulation on an image, performed in CUDA.

Public Member Functions

std::shared_ptr< SharedImagedemodulate (const SharedImage &image, double samplingFrequency, double demodulationFrequency, int decimationFactor, int axis, double signalFractionalBandwidth=1.0, int filterLength=101) const
 Perform IQ demodulation along the given axis of the image and the given frequency, performed in CUDA.
 IqDemodulation (const IqDemodulation &)=delete
IqDemodulation & operator= (const IqDemodulation &)=delete
 IqDemodulation (IqDemodulation &&)
IqDemodulation & operator= (IqDemodulation &&)

Member Function Documentation

◆ demodulate()

std::shared_ptr< SharedImage > ImFusion::US::GPU::IqDemodulation::demodulate ( const SharedImage & image,
double samplingFrequency,
double demodulationFrequency,
int decimationFactor,
int axis,
double signalFractionalBandwidth = 1.0,
int filterLength = 101 ) const

Perform IQ demodulation along the given axis of the image and the given frequency, performed in CUDA.

Parameters
imageThe image to demodulate
samplingFrequencyThe sampling frequency of the image in the target axis
demodulationFrequencyThe frequency to demodulate the image with
decimationFactorDesired decimation factor while demodulating. The output image size in the specified axis will be image.dimensions()[axis] / decimationFactor.
axisThe axis along which to demodulate the image
signalFractionalBandwidthThe fractional bandwidth (relative to the demodulation frequency) to retain during the demodulation.
filterLengthThe length of the FIR filter to use for lowpass filtering the demodulated signal
Returns
The demodulated image
Note
The output image will have the same dimensions as the input image, except for the specified axis, which will be reduced by the decimation factor.
Exceptions
std::invalid_argumentif the axis is not in the range [0, 2], or if the decimation factor is not positive

The documentation for this class was generated from the following file:
  • ImFusion/USImgFormation/CUDA/IqDemodulation.h
Search Tab / S to search, Esc to close