ImFusion C++ SDK 4.5.0
ImFusion::US::FrameAcquisitionWidget Class Reference

#include <ImFusion/USImgFormation/FrameAcquisitionWidget.h>

Widget to configure a FrameAcquisition, intended to be used mainly through the AcquisitionSequenceWidget. More...

Inheritance diagram for ImFusion::US::FrameAcquisitionWidget:

Detailed Description

Widget to configure a FrameAcquisition, intended to be used mainly through the AcquisitionSequenceWidget.

Classes

struct  ReceiveSamplingFrequencyRange
 receive sampling frequency [Hz] range pair with (min <= f <= max) More...
struct  ReceiveSamplingFrequencyUnrestricted
 Tag type to indicate unrestricted receive sampling frequency. More...

Public Types

using ReceiveSamplingFrequencyOptions = Utils::Variant<std::monostate, ReceiveSamplingFrequencyUnrestricted, ReceiveSamplingFrequencyRange>

Signals

void frameAcquisitionChanged (const FrameAcquisition &frameAcquisition)
 Signal that parameters from the current FrameAcquisition have changed.

Public Member Functions

 FrameAcquisitionWidget (QWidget *parent=nullptr)
void initGUI ()
void updateGUI (bool noValues)
 Updates the GUI to reflect the current FrameAcquisition configuration.
void setFrameAcquisition (const FrameAcquisition &frameAcquisition)
 Sets the FrameAcquisition to be displayed and edited. Does not trigger a signal.
void setTransducer (const Transducer &transducer)
 Sets the transducer to be used for the FrameAcquisition configuration.
const FrameAcquisitionframeAcquisition () const
 Returns the FrameAcquisition as it was last modified from the GUI or set from the outside.
void setReceiveSamplingFrequencyOptions (ReceiveSamplingFrequencyOptions receiveFrequencyOptions)
 Sets the user selectable range of receive sampling frequencies, to accomodate for hardware restrictions.

Member Function Documentation

◆ updateGUI()

void ImFusion::US::FrameAcquisitionWidget::updateGUI ( bool noValues)

Updates the GUI to reflect the current FrameAcquisition configuration.

If noValues is true, the values in the GUI elements will not be updated, only the appropriate tab group will be selected.

◆ setTransducer()

void ImFusion::US::FrameAcquisitionWidget::setTransducer ( const Transducer & transducer)

Sets the transducer to be used for the FrameAcquisition configuration.

The FrameAcquisition will be updated and signaled immediately.

◆ setReceiveSamplingFrequencyOptions()

void ImFusion::US::FrameAcquisitionWidget::setReceiveSamplingFrequencyOptions ( ReceiveSamplingFrequencyOptions receiveFrequencyOptions)

Sets the user selectable range of receive sampling frequencies, to accomodate for hardware restrictions.

If the current value is outside the new range, it will be clamped to the new range. If monostate is passed, the receive sampling frequency will not be configurable by the user and be fully defined by the interface instead.


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