GlSliceRendererSweep Class Reference

#include <ImFusion/US/GlSliceRendererSweep.h>

Enables GlSlice to render freehand Ultrasound Sweeps. More...

Inheritance diagram for GlSliceRendererSweep:

Detailed Description

Enables GlSlice to render freehand Ultrasound Sweeps.

This renderer accepts all objects that dynamic_cast to UltrasoundSweep.

See also

GlSlice, UltrasoundSweep

Public Types
enum class	CompoundingMode { DirectRendering = 0 , BackwardCompounding = 1 }
	Compounding mode to use for rendering. More...
enum	InterpolationMode : int { NearestNeighbor = 0 , LinearInterpolation = 1 }
	Interpolation mode during rendering. More...

Public Member Functions
	GlSliceRendererSweep ()
	Instantiates a new GlSliceRendererSweep using the given masking decorator.
bool	showAll () const
	Returns the whether the sweep's selection shall be ignored (i.e. all frames are to be shown).
void	setShowAll (bool value)
	Sets the whether the sweep's selection shall be ignored (i.e. all frames are to be shown).
InterpolationMode	interpolationMode () const
	Returns the interpolation mode.
void	setInterpolationMode (InterpolationMode value)
	Sets the interpolation mode.
CompoundingMode	compoundingMode () const
	Returns the compounding mode to use.
void	setCompoundingMode (CompoundingMode value)
	Sets the compounding mode to use.
double	originalPlaneAngleTolerance () const
	Returns the angular tolerance (in degrees) until which a matrix is considered "original" and no compounding is performed.
void	setOriginalPlaneAngleTolerance (double value)
	Sets the angular tolerance (in degrees) until which a matrix is considered "original" and no compounding is performed.
double	originalPlaneTranslationTolerance () const
	Returns the out-of-plane translation tolerance (in mm) until which a matrix is considered "original" and no compounding is performed.
void	setOriginalPlaneTranslationTolerance (double value)
	Sets the out-of-plane translation tolerance (in mm) until which a matrix is considered "original" and no compounding is performed.
void	setOriginalPlaneTolerance (double translation, double angle)
	Set both angular and distance tolerances until which a matrix is considered "original" and no compounding is performed.
bool	isOriginalPlane (const Slice &slice, const mat4 &mat, bool *flipNeeded=nullptr) const
	Checks if the given matrix is sufficiently close to a given slice.
double	frameThickness () const
	Returns the slice thickness (mm) in backward compounding mode; 0 if using automatic setting.
void	setFrameThickness (double value)
	Sets the slice thickness (mm) in backward compounding mode; 0 if using automatic setting.
void	setMaxDistance (double dist)
	Sets the maximum distance between slices to render if dist is positive, otherwise uses automatic setting (10% of max.
void	setSharpening (double sharpenFactor, double sharpenAngleWeighting)
	Set optional image sharpening as post-processing step.
std::string	name () const override
	Returns the name for identification/GUI usage of this slice renderer.
bool	accepts (const Data *d) const override
	Returns whether this slice renderer is capable of displaying the given data.
void	render (const GL::ViewState &viewState, const Slice &slice, const Data &data, const DisplayOptions2d &displayOptions, bool encodeDistance) override
	Renders the data in the given configuration.
mat4	defaultPose (const Data &data, Slice::AnatomicalPlane originalPlane) const override
	Returns the default view matrix to use for showing the given dataset in a slice view of the given anatomical plane.
vec2	extent (const Slice &slice, const Data &data) override
	Returns the 2D extent of the data when rendering it onto slice in pixels.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from GlSliceRenderer
	GlSliceRenderer ()=default
	Creates a new GlSliceRenderer using the given decorator for masking.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

CompoundingMode

enum class CompoundingMode

strong

Compounding mode to use for rendering.

Enumerator
DirectRendering	Direct rendering (hybrid method)
BackwardCompounding	Full backward compounding.

InterpolationMode

enum InterpolationMode : int

Interpolation mode during rendering.

Enumerator
NearestNeighbor	Nearest neighbor interpolation.
LinearInterpolation	Linear interpolation.

Member Function Documentation

setMaxDistance()

void setMaxDistance

(

double

dist

)

Sets the maximum distance between slices to render if dist is positive, otherwise uses automatic setting (10% of max.

sweep extent)

Note

Only applies to DirectRendering compounding mode.

setSharpening()

void setSharpening	(	double	sharpenFactor,
		double	sharpenAngleWeighting )

Set optional image sharpening as post-processing step.

Parameters

sharpenFactor	Strength of sharpen filter, range [0..1]
sharpenAngleWeighting	Controls the influence of the view angle, range [0..1]: 0 will sharpen all parts equally, 1 will sharpen only parts that are orthogonal to the view direction

name()

std::string name ( ) const

overridevirtual

Returns the name for identification/GUI usage of this slice renderer.

Implements GlSliceRenderer.

accepts()

bool accepts ( const Data * data ) const

overridevirtual

Returns whether this slice renderer is capable of displaying the given data.

Implements GlSliceRenderer.

render()

void render ( const GL::ViewState & viewState, const Slice & slice, const Data & data, const DisplayOptions2d & displayOptions, bool encodeDistance )

overridevirtual

Renders the data in the given configuration.

Parameters

viewState	GlState object defining view and projection matrices.
slice	Slice on which to render the data.
data	The data to render
displayOptions	The display options to use for rendering.
encodeDistance	Flag whether to encode the distance to the border in the secondary color buffer.

Note

Call this method only with data that is accepted by this renderer.

Implements GlSliceRenderer.

defaultPose()

mat4 defaultPose ( const Data & data, Slice::AnatomicalPlane originalPlane ) const

overridevirtual

Returns the default view matrix to use for showing the given dataset in a slice view of the given anatomical plane.

This function is for instance use by the reset function of ImageView2D/GlSliceView.

Note

Call this method only with data that is accepted by this renderer.

Implements GlSliceRenderer.

extent()

vec2 extent ( const Slice & slice, const Data & data )

overridevirtual

Returns the 2D extent of the data when rendering it onto slice in pixels.

Note

Call this method only with data that is accepted by this renderer.

Implements GlSliceRenderer.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

---

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

• ImFusion/US/GlSliceRendererSweep.h