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, int width, int height) -> std::shared_ptr<ClariusStreamer>
Create instance.
void setConnectionAddress(std::string ipAddress)
void setConnectionPort(int port)
void stop() override
Stop the stream.
auto getNrOfFrames() -> uint
void newProcessedImage(const void* img, const _CusProcessedImageInfo* nfo, int npos, const _CusPosInfo* pos)
void toggleFreeze()
void increaseDepth()
void decreaseDepth()
void setDepth(float depth)
void setGain(float gain)
void loadAttributes() override
void signalCastStop(std::string stopMessage = "")
void signalDisconnect()
void stopPipeline() override
Stop a pipeline.
void setOutputSize(int width, int height)

Protected functions

void generateStream() override

Private functions

void execute() virtual

Function documentation

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

Create instance.

Parameters
ipAddress IP address to scanner
port Port to scanner
grayscale Converts images to grayscale
width Output image width of scanconverted image
height Output image height of scanconverted image
Returns instance

void fast::ClariusStreamer::stop() override

Stop the stream.

The streaming thread has finished when this method returns. This method should not be called from the streaming thread.

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 protected

The function producing the data stream