FrameGeometryConvex3D Class Reference

#include <ImFusion/US/FrameGeometry3D.h>

Describes the specific convex acquisition parameters of a 3D ultrasound frame. More...

Inheritance diagram for FrameGeometryConvex3D:

Detailed Description

Describes the specific convex acquisition parameters of a 3D ultrasound frame.

Public Member Functions
std::string	id () const override
	Returns a unique string identifier for this type of data component.
bool	operator== (const FrameGeometryConvex3D &other) const
bool	operator!= (const FrameGeometryConvex3D &other) const
Public Member Functions inherited from DataComponent< FrameGeometryConvex3D >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
std::unique_ptr< Subclass >	cloneDerived () const
bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.
Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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

Public Attributes
Parameter< double >	p_steeringLateralMin {"steeringLateralMin", -35.0, this}
	minimal angular position in degrees
Parameter< double >	p_steeringLateralSpan {"steeringLateralSpan", 70.0, this}
	angular scanning span in degrees
Parameter< double >	p_steeringElevationalMin {"steeringElevationalMin", -35.0, this}
	minimal angular z position in degrees for 3D scans
Parameter< double >	p_steeringElevationalSpan {"steeringElevationalSpan", 70.0, this}
	angular z scanning span in degrees for 3D scans
Parameter< double >	p_zAxialMin {"zAxialMin", 10.0, this}
	z wobbling offset for 3D scans
Parameter< bool >	p_pyramidMode {"pyramidMode", false, this}
	If true, the scanlines angles are spaced uniformly in a orthogonal grid (in spherical coordinates), the volume is then the sector of a spherical shell (with spherical rectangular base).
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

id()

std::string id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements DataComponentBase.

Member Data Documentation

p_pyramidMode

Parameter<bool> p_pyramidMode {"pyramidMode", false, this}

If true, the scanlines angles are spaced uniformly in a orthogonal grid (in spherical coordinates), the volume is then the sector of a spherical shell (with spherical rectangular base).

If false, the cross section (on the xy, lateral, elevational plane) of the resulting volume has an hourglass shape.

---

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

• ImFusion/US/FrameGeometry3D.h