fast::ClariusStreamer class

Stream ultrasound images from a Clarius scanner.

Uses the Clarius cast API library to stream images from a Clarius ultrasound scanner in real-time.

Default streaming mode is StreamingMode::NewestFrameOnly

Output ports

  • 0: Image - Ultrasound image

Base classes

class Streamer
Abstract base class for all Streamers.

Constructors, destructors, conversion operators

~ClariusStreamer()

Public functions

auto create(std::string ipAddress, int port, bool grayscale) -> std::shared_ptr<ClariusStreamer>
Create instance.
void setConnectionAddress(std::string ipAddress)
void setConnectionPort(int port)
void stop() virtual
auto getNrOfFrames() -> uint
void newImageFn(const void* newImage, const _ClariusProcessedImageInfo* nfo, int npos, const _ClariusPosInfo* pos)
void toggleFreeze()
void increaseDepth()
void decreaseDepth()
void setDepth(float depth)
void setGain(float gain)
void loadAttributes() override

Private functions

void execute() virtual
void generateStream() override

Function documentation

std::shared_ptr<ClariusStreamer> fast::ClariusStreamer::create(std::string ipAddress, int port, bool grayscale)

Create instance.

Parameters
ipAddress
port
grayscale
Returns instance

void fast::ClariusStreamer::stop() virtual

Stop the stream

void fast::ClariusStreamer::setDepth(float depth)

Set depth in centimeters

void fast::ClariusStreamer::setGain(float gain)

Set gain in percentage

void fast::ClariusStreamer::generateStream() override private

The function producing the data stream