ImFusion::US::FrameGeometryUtils Namespace Reference

Utilities to generate different instances of FrameGeometry. More...

Detailed Description

Utilities to generate different instances of FrameGeometry.

Functions
void	initialize (FrameGeometry &frameGeom, const FrameGeometry &previous)
	Initializes a FrameGeometry using the previous FrameGeometry as reference.
void	initialize (FrameGeometry &frameGeom, const ImageDescriptor &desc)
	Initializes a FrameGeometry with smart default values for the given ImageDescriptor.
void	initialize (FrameGeometryLinear &linear, const ImageDescriptor &desc)
	Initializes a FrameGeometryLinear with smart default values for the given ImageDescriptor.
void	initialize (FrameGeometrySector &sector, const ImageDescriptor &desc)
	Initializes a FrameGeometrySector with smart default values for the given ImageDescriptor.
void	initialize (FrameGeometryCircular &circ, const ImageDescriptor &desc)
	Initializes a FrameGeometryCircular with smart default values for the given ImageDescriptor.
void	initialize (FrameGeometryConvex &convex, const ImageDescriptor &desc)
	Initializes a FrameGeometryConvex with smart default values for the given ImageDescriptor.
std::unique_ptr< US::FrameGeometryLinear >	entireImage (const ImageDescriptor &desc)
	Creates a FrameGeometryLinear covering the entire image.
void	entireImage (FrameGeometry &frameGeom, const ImageDescriptor &desc)
	Initializes the frame geometry to cover the entire image.
void	entireImage (FrameGeometryLinear &linear, const ImageDescriptor &desc)
	Initializes the linear frame geometry to cover the entire image.
void	entireImage (FrameGeometrySector &sector, const ImageDescriptor &desc, double longRadiusHeightFactor=1.2)
	Initializes the sector frame geometry to cover the entire image Use the longRadiusHeightScale to adjust the large radius of the fan as a factor of the height A larger value will result in a wider fan, whereas a small value will result in a tighter and pointy fan The value must be above 1.0 for a valid fan.
void	entireImage (FrameGeometryCircular &circular, const ImageDescriptor &desc)
	Initializes the circular frame geometry to cover the entire image.
void	entireImage (FrameGeometryConvex &convex, const ImageDescriptor &desc, double longRadiusHeightFactor=1.2)
	Initializes the convex frame geometry to cover the entire image Use the longRadiusHeightScale to adjust the large radius of the fan as a factor of the height A larger value will result in a wider fan, whereas a small value will result in a tighter and pointy fan The value must be above 1.0 for a valid fan.
void	scaleLengthParameters (FrameGeometry &frameGeom, const vec2 &scale)
	Scales horizontal and vertical parameters according to the given scale factor.
std::unique_ptr< US::FrameGeometryLinear >	createLinear (US::CoordinateSystem coordSys, const ImageDescriptor &imageDesc, const vec2 &offset, const double width, const double depth, const double steeringAngle=0, const bool isTopDown=true)
	Creates a linear frame geometry with control over the probe layout, with an optional steering angle.
std::unique_ptr< US::FrameGeometrySector >	createSector (US::CoordinateSystem coordSys, const ImageDescriptor &imageDesc, const vec2 &offset, const double openingAngle, const double shortRadius, const double longRadius, const double bottomCurvature, const bool isTopDown=true)
	Creates a sector geometry with control over angular spread, radii, and curvature to model real-world probe characteristics.
std::unique_ptr< US::FrameGeometryConvex >	createConvex (US::CoordinateSystem coordSys, const ImageDescriptor &imageDesc, const vec2 &offset, const double openingAngle, const double shortRadius, const double longRadius, const bool isTopDown=true)
	Creates a curved geometry with control over angular spread, radii, and curvature to model real-world probe characteristics.
std::unique_ptr< US::FrameGeometryCircular >	createCircular (US::CoordinateSystem coordSys, const ImageDescriptor &imageDesc, const vec2 &offset, const double shortRadius, const double longRadius, const bool isTopDown=true)
	Creates a circular geometry with control over internal and external radii and offset to model real-world probe characteristics.
std::optional< vec2 >	apex (const FrameGeometry &frameGeom)
	Returns the fan's apex point if there is one.

Function Documentation

entireImage()

std::unique_ptr< US::FrameGeometryLinear > entireImage

(

const ImageDescriptor &

desc

)

Creates a FrameGeometryLinear covering the entire image.

Deprecated

"Use the entireImage overload for linear instead"

createLinear()

std::unique_ptr< US::FrameGeometryLinear > createLinear	(	US::CoordinateSystem	coordSys,
		const ImageDescriptor &	imageDesc,
		const vec2 &	offset,
		const double	width,
		const double	depth,
		const double	steeringAngle = 0,
		const bool	isTopDown = true )

Creates a linear frame geometry with control over the probe layout, with an optional steering angle.

Defaults to a topdown view. See FrameGeometryLinear for a detailed summary.

createSector()

std::unique_ptr< US::FrameGeometrySector > createSector	(	US::CoordinateSystem	coordSys,
		const ImageDescriptor &	imageDesc,
		const vec2 &	offset,
		const double	openingAngle,
		const double	shortRadius,
		const double	longRadius,
		const double	bottomCurvature,
		const bool	isTopDown = true )

Creates a sector geometry with control over angular spread, radii, and curvature to model real-world probe characteristics.

Defaults to a topdown view. See FrameGeometrySector for a detailed summary.

createConvex()

std::unique_ptr< US::FrameGeometryConvex > createConvex	(	US::CoordinateSystem	coordSys,
		const ImageDescriptor &	imageDesc,
		const vec2 &	offset,
		const double	openingAngle,
		const double	shortRadius,
		const double	longRadius,
		const bool	isTopDown = true )

Creates a curved geometry with control over angular spread, radii, and curvature to model real-world probe characteristics.

Defaults to a topdown view. See FrameGeometryConvex for a detailed summary.

createCircular()

std::unique_ptr< US::FrameGeometryCircular > createCircular	(	US::CoordinateSystem	coordSys,
		const ImageDescriptor &	imageDesc,
		const vec2 &	offset,
		const double	shortRadius,
		const double	longRadius,
		const bool	isTopDown = true )

Creates a circular geometry with control over internal and external radii and offset to model real-world probe characteristics.

Defaults to a topdown view. See FrameGeometryCircular for a detailed summary.