#include <UFFStreamer.hpp>

Inheritance diagram for fast::UFFStreamer:

Collaboration diagram for fast::UFFStreamer:

Public Member Functions
	UFFStreamer ()

void	setFilename (std::string filename)

void	execute () override

int	getNrOfFrames () override

void	setName (std::string name)

void	loadAttributes () override

	~UFFStreamer ()

Public Member Functions inherited from fast::RandomAccessStreamer
virtual void	setPause (bool pause)

virtual bool	getPause ()

virtual int	getCurrentFrameIndex ()

virtual void	setCurrentFrameIndex (int index)

virtual int	getCurrentFrameIndexAndUpdate ()

virtual int	getFramerate () const

virtual void	setFramerate (int framerate)

virtual void	stop () override

void	setLooping (bool loop)

void	frameAdded () override

Public Member Functions inherited from fast::Streamer
	Streamer ()

virtual	~Streamer ()

virtual std::string	getNameOfClass () const =0

virtual void	setMaximumNrOfFrames (int maximumNrOfFrames)

Public Member Functions inherited from fast::ProcessObject
virtual	~ProcessObject ()

void	update (int executeToken=-1)

RuntimeMeasurement::pointer	getRuntime ()

RuntimeMeasurement::pointer	getRuntime (std::string name)

RuntimeMeasurementsManager::pointer	getAllRuntimes ()

void	enableRuntimeMeasurements ()

void	disableRuntimeMeasurements ()

void	setMainDevice (ExecutionDevice::pointer device)

void	setMainDeviceCriteria (const DeviceCriteria &citeria)

ExecutionDevice::pointer	getMainDevice () const

void	setDevice (uint deviceNumber, ExecutionDevice::pointer device)

void	setDeviceCriteria (uint deviceNumber, const DeviceCriteria &criteria)

ExecutionDevice::pointer	getDevice (uint deviceNumber) const

virtual DataChannel::pointer	getOutputPort (uint portID=0)

virtual DataChannel::pointer	getInputPort (uint portID=0)

virtual void	setInputConnection (DataChannel::pointer port)

virtual void	setInputConnection (uint portID, DataChannel::pointer port)

virtual void	setInputData (DataObject::pointer data)

virtual void	setInputData (uint portID, DataObject::pointer data)

int	getNrOfInputConnections () const

int	getNrOfOutputPorts () const

std::shared_ptr< Attribute >	getAttribute (std::string id)

std::unordered_map< std::string, std::shared_ptr< Attribute > >	getAttributes ()

void	setAttributes (std::vector< std::shared_ptr< Attribute >> attributes)

void	stopPipeline ()

void	setModified (bool modified)

template<class DataType >
std::shared_ptr< DataType >	updateAndGetOutputData (uint portID=0)

Public Member Functions inherited from fast::Object
	Object ()

virtual	~Object ()

Reporter &	getReporter ()

Protected Member Functions
void	generateStream () override

Protected Member Functions inherited from fast::RandomAccessStreamer
virtual void	waitForUnpause ()

Protected Member Functions inherited from fast::Streamer
virtual void	waitForFirstFrame ()

virtual void	startStream ()

Protected Member Functions inherited from fast::ProcessObject
	ProcessObject ()

virtual void	preExecute ()

virtual void	postExecute ()

template<class DataType >
void	createInputPort (uint portID, bool required=true)

template<class DataType >
void	createOutputPort (uint portID)

template<class DataType >
std::shared_ptr< DataType >	getInputData (uint portID=0)

template<class DataType >
std::shared_ptr< DataType >	getOutputData (uint portID=0)

void	addOutputData (uint portID, DataObject::pointer data)

bool	hasNewInputData (uint portID)

virtual void	waitToFinish ()

void	createOpenCLProgram (std::string sourceFilename, std::string name="")

cl::Program	getOpenCLProgram (std::shared_ptr< OpenCLDevice > device, std::string name="", std::string buildOptions="")

void	createFloatAttribute (std::string id, std::string name, std::string description, float initialValue)

void	createIntegerAttribute (std::string id, std::string name, std::string description, int initialValue)

void	createBooleanAttribute (std::string id, std::string name, std::string description, bool initialValue)

void	createStringAttribute (std::string id, std::string name, std::string description, std::string initialValue)

float	getFloatAttribute (std::string id)

int	getIntegerAttribute (std::string id)

bool	getBooleanAttribute (std::string id)

std::string	getStringAttribute (std::string id)

std::vector< float >	getFloatListAttribute (std::string id)

std::vector< int >	getIntegerListAttribute (std::string id)

std::vector< bool >	getBooleanListAttribute (std::string id)

std::vector< std::string >	getStringListAttribute (std::string id)

void	changeDeviceOnInputs (uint deviceNumber, ExecutionDevice::pointer device)

void	validateInputPortExists (uint portID)

void	validateOutputPortExists (uint portID)

Protected Member Functions inherited from fast::Object
Reporter &	reportError ()

Reporter &	reportWarning ()

Reporter &	reportInfo ()

ReporterEnd	reportEnd () const

Protected Attributes
std::string	m_filename

std::string	m_name

std::shared_ptr< UFFData >	m_uffData

Protected Attributes inherited from fast::RandomAccessStreamer
int	m_framerate

bool	m_pause = false

bool	m_pauseAfterOneFrame = false

std::mutex	m_playbackMutex

std::mutex	m_pauseMutex

std::condition_variable	m_pauseCV

int	m_currentFrameIndex

bool	m_loop

Protected Attributes inherited from fast::Streamer
bool	m_firstFrameIsInserted = false

bool	m_streamIsStarted = false

bool	m_stop = false

std::mutex	m_firstFrameMutex

std::mutex	m_stopMutex

std::unique_ptr< std::thread >	m_thread

std::condition_variable	m_firstFrameCondition

Protected Attributes inherited from fast::ProcessObject
bool	mIsModified

int	m_lastExecuteToken = -1

RuntimeMeasurementsManager::pointer	mRuntimeManager

std::unordered_map< uint, bool >	mRequiredInputs

std::unordered_map< uint, std::vector< uint > >	mInputDevices

std::unordered_map< uint, ExecutionDevice::pointer >	mDevices

std::unordered_map< uint, DeviceCriteria >	mDeviceCriteria

std::unordered_map< uint, DataChannel::pointer >	mInputConnections

std::unordered_map< uint, std::vector< std::weak_ptr< DataChannel > > >	mOutputConnections

std::unordered_map< uint, bool >	mInputPorts

std::unordered_set< uint >	mOutputPorts

std::unordered_map< uint, std::pair< DataObject::pointer, uint64_t > >	mLastProcessed

std::unordered_map< std::string, std::shared_ptr< OpenCLProgram > >	mOpenCLPrograms

std::unordered_map< std::string, std::shared_ptr< Attribute > >	mAttributes

std::unordered_map< std::string, std::string >	m_frameData

std::unordered_set< std::string >	m_lastFrame

int	m_maximumNrOfFrames = -1

Protected Attributes inherited from fast::Object
std::weak_ptr< Object >	mPtr

Additional Inherited Members
Public Types inherited from fast::Streamer
typedef std::shared_ptr< Streamer >	pointer

Public Types inherited from fast::ProcessObject
typedef std::shared_ptr< ProcessObject >	pointer

Public Types inherited from fast::Object
typedef std::shared_ptr< Object >	pointer

Static Public Member Functions inherited from fast::Streamer
static std::string	getStaticNameOfClass ()

Static Public Member Functions inherited from fast::ProcessObject
static std::string	getStaticNameOfClass ()

Static Public Member Functions inherited from fast::Object
static std::string	getStaticNameOfClass ()

Detailed Description

A streamer for reading data stored in the ultrasound file format (UFF) which is essentially and HDF5 file with ultrasound image/beam data.

Constructor & Destructor Documentation

◆ UFFStreamer()

fast::UFFStreamer::UFFStreamer ( )

◆ ~UFFStreamer()

fast::UFFStreamer::~UFFStreamer ( )

Member Function Documentation

◆ execute()

void fast::UFFStreamer::execute ( )

overridevirtual

Implements fast::ProcessObject.

◆ generateStream()

void fast::UFFStreamer::generateStream ( )

overrideprotectedvirtual

The function producing the data stream

Implements fast::Streamer.

◆ getNrOfFrames()

int fast::UFFStreamer::getNrOfFrames ( )

overridevirtual

Implements fast::RandomAccessStreamer.

◆ loadAttributes()

void fast::UFFStreamer::loadAttributes ( )

overridevirtual

Reimplemented from fast::ProcessObject.

◆ setFilename()

void fast::UFFStreamer::setFilename ( std::string filename )

◆ setName()

void fast::UFFStreamer::setName ( std::string name )

Member Data Documentation

◆ m_filename

std::string fast::UFFStreamer::m_filename

protected

◆ m_name

std::string fast::UFFStreamer::m_name

protected

◆ m_uffData

std::shared_ptr<UFFData> fast::UFFStreamer::m_uffData

protected

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

Streamers/UFFStreamer.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UFFStreamer()

◆ ~UFFStreamer()

Member Function Documentation

◆ execute()

◆ generateStream()

◆ getNrOfFrames()

◆ loadAttributes()

◆ setFilename()

◆ setName()

Member Data Documentation

◆ m_filename

◆ m_name

◆ m_uffData