Utilities

Utility functions for the ultrasound image formation plugin. More...

Collaboration diagram for Utilities:

Detailed Description

Utility functions for the ultrasound image formation plugin.

Enumerations
enum class	ImFusion::US::Signal::FilterType { Lowpass , Highpass , Bandpass }
	Type of FIR filter.

Functions
TypedImage< float >	ImFusion::US::Signal::sinusoidReal (float samplingFrequency, float signalFrequency, int signalLength, float amplitude=1.0f, float phase=0.0f, int axis=0)
	Creates a 1D image with a sinusoid of the given frequency and length, phase = 0 means the signal is A*cos(f*2*pi*t).
TypedImage< float >	ImFusion::US::Signal::sinusoidComplex (float samplingFrequency, float signalFrequency, int signalLength, float amplitude=1.0f, float phase=0.0f, int axis=0)
	Creates a two-channel, 1D image with a complex sinusoid of the given frequency and length, A*exp(i*f*2*pi*t) = A*cos(f*2*pi*t) + A*i * sin(f*2*pi*t).
TypedImage< float >	ImFusion::US::Signal::createFirFilter (FilterType filterType, float samplingFrequency, float cutoffFrequencyLower, float cutoffFrequencyUpper, int filterLength, int axis=0)
	Creates a finite impulse response (FIR) filter, weighted with a hamming window, returned as a 1D image.
bool	ImFusion::US::isChannelData (const SharedImageSet &imageSet, int which=-1)
	returns true if image set is a valid representation of the concept ChannelData, i.e.
bool	ImFusion::US::isChannelData (const DataComponentList &components)
	returns true if data component list is a valid representation of the concept ChannelData, i.e.
const FrameAcquisition &	ImFusion::US::getFrameAcquisition (const SharedImageSet &imageSet, int which=-1)
	Shortcut to get FrameAcquisition from a SharedImageSet.
const FrameAcquisition &	ImFusion::US::getFrameAcquisition (const DataComponentList &components)
	Shortcut to get FrameAcquisition from a DataComponentList.
std::unique_ptr< MemImage >	ImFusion::US::permuteChannelData (const MemImage &inImage, const ChannelDataLayout &inputLayout, const ChannelDataLayout &outputLayout)
	Utility function to permute the channel data layout of a MemImage.

Function Documentation

createFirFilter()

TypedImage< float > ImFusion::US::Signal::createFirFilter	(	FilterType	filterType,
		float	samplingFrequency,
		float	cutoffFrequencyLower,
		float	cutoffFrequencyUpper,
		int	filterLength,
		int	axis = 0 )

#include <ImFusion/USImgFormation/SignalProcessing.h>

Creates a finite impulse response (FIR) filter, weighted with a hamming window, returned as a 1D image.

The value of cutoffFrequencyLower is only used for highpass and bandpass filters. The value of cutoffFrequencyUpper is only used for lowpass and bandpass filters.

isChannelData() [1/2]

bool ImFusion::US::isChannelData	(	const SharedImageSet &	imageSet,
		int	which = -1 )

#include <ImFusion/USImgFormation/Utils.h>

returns true if image set is a valid representation of the concept ChannelData, i.e.

has FrameAcquisition as elementwise DataComponent, and has modality ULTRASOUND

isChannelData() [2/2]

bool ImFusion::US::isChannelData

(

const DataComponentList &

components

)

#include <ImFusion/USImgFormation/Utils.h>

returns true if data component list is a valid representation of the concept ChannelData, i.e.

has FrameAcquisition as elementwise DataComponent

getFrameAcquisition() [1/2]

const FrameAcquisition & ImFusion::US::getFrameAcquisition	(	const SharedImageSet &	imageSet,
		int	which = -1 )

#include <ImFusion/USImgFormation/Utils.h>

Shortcut to get FrameAcquisition from a SharedImageSet.

This method requires that the DataComponent exists in sis.components(which) If this is not certain use isChannelData() to check first.

getFrameAcquisition() [2/2]

const FrameAcquisition & ImFusion::US::getFrameAcquisition

(

const DataComponentList &

components

)

#include <ImFusion/USImgFormation/Utils.h>

Shortcut to get FrameAcquisition from a DataComponentList.

This method requires that the DataComponent exists in the list If this is not certain use isChannelData() to check first.

permuteChannelData()

std::unique_ptr< MemImage > ImFusion::US::permuteChannelData	(	const MemImage &	inImage,
		const ChannelDataLayout &	inputLayout,
		const ChannelDataLayout &	outputLayout )

#include <ImFusion/USImgFormation/Utils.h>

Utility function to permute the channel data layout of a MemImage.

CPU only, should not be used for performance-critical code.