SweepCroppingAlgorithm Class Reference

#include <ImFusion/US/SweepCroppingAlgorithm.h>

Algorithm for cropping, binning (downsampling), and vertical flipping of ultrasound image data, with full correction of associated tracking and geometry metadata. More...

Inheritance diagram for SweepCroppingAlgorithm:

Detailed Description

Algorithm for cropping, binning (downsampling), and vertical flipping of ultrasound image data, with full correction of associated tracking and geometry metadata.

This algorithm is designed for preprocessing ultrasound sweeps, allowing you to:

• Crop pixels from the lower-left and upper-right corners of each image frame.
• Downsample (bin) images by integer factors in X and Y.
• Vertically flip images if required.

In contrast to generic image processing algorithms, this class also ensures that all relevant metadata is updated consistently:

• Tracking data (calibration matrices) are corrected to reflect the new image geometry.
• FrameGeometry metadata is updated, including offset and top-down orientation, so that spatial relationships remain valid after cropping or flipping.

This is especially useful when preparing ultrasound data for further processing or visualization, ensuring that both the image content and its spatial context remain consistent.

Example usage:

SweepCroppingAlgorithm algo(sharedImageSet);
algo.setCropLower({10, 20});
algo.setCropUpper({5, 5});
algo.setBinning({2, 2});
algo.setFlip(true);
algo.setCreateNew(true);
algo.compute();
auto result = algo.takeOutput();

Public Member Functions
	SweepCroppingAlgorithm (SharedImageSet &sharedImageSet)
	SweepCroppingAlgorithm (const std::vector< SharedImageSet * > &sis)
vec2i	cropLower () const
	Get the lower-left cropping in pixels (may be negative).
void	setCropLower (vec2i value)
	Set the lower-left cropping in pixels (may be negative).
vec2i	cropUpper () const
	Get the upper-right cropping in pixels (may be negative).
void	setCropUpper (vec2i value)
	Set and get the upper-right cropping in pixels (may be negative).
vec2i	binning () const
	Get the applied binning (downsampling) factor.
void	setBinning (vec2i value)
	Set the applied binning (downsampling) factor.
bool	flip () const
	Get whether the image will be vertically flipped.
void	setFlip (bool flip)
	Set whether the image will be vertically flipped.
bool	createNew () const
	Get whether to create a new image instead of performing an in-place operation.
void	setCreateNew (bool value)
	Set whether to create a new image instead of performing an in-place operation.
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.
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
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

Static Public Member Functions
static Geometry::AlignedBox	cropBounds (const US::FrameGeometry &geometry)
	Computes the axis aligned bounding box of the given ultrasound FrameGeometry in pixel coordinates.
static bool	createCompatible (const DataList &data, Algorithm **a)
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Additional Inherited Members
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

cropBounds()

static Geometry::AlignedBox cropBounds ( const US::FrameGeometry & geometry )

static

Computes the axis aligned bounding box of the given ultrasound FrameGeometry in pixel coordinates.

The resulting bounding box can be used to set the crop parameters to precisely cover the region of the FrameGeometry.

Parameters

geometry

FrameGeometry for which to compute the pixel bounds.

Returns

Bounding box in pixel coordinates as a Geometry::AlignedBox.

cropLower()

vec2i cropLower

(

)

const

Get the lower-left cropping in pixels (may be negative).

This specifies how many pixels to crop from the lower-left corner of the image.

setCropLower()

void setCropLower

(

vec2i

value

)

Set the lower-left cropping in pixels (may be negative).

This specifies how many pixels to crop from the lower-left corner of the image.

cropUpper()

vec2i cropUpper

(

)

const

Get the upper-right cropping in pixels (may be negative).

Specifies how many pixels to crop from the upper-right corner of the image.

setCropUpper()

void setCropUpper

(

vec2i

value

)

Set and get the upper-right cropping in pixels (may be negative).

Specifies how many pixels to crop from the upper-right corner of the image.

binning()

vec2i binning

(

)

const

Get the applied binning (downsampling) factor.

Each dimension must be >= 1. A value of (1,1) means no binning.

setBinning()

void setBinning

(

vec2i

value

)

Set the applied binning (downsampling) factor.

Each dimension must be >= 1. A value of (1,1) means no binning.

flip()

bool flip

(

)

const

Get whether the image will be vertically flipped.

If enabled, the image is flipped along the vertical axis.

setFlip()

void setFlip

(

bool

flip

)

Set whether the image will be vertically flipped.

If enabled, the image is flipped along the vertical axis.

createNew()

bool createNew

(

)

const

Get whether to create a new image instead of performing an in-place operation.

If true, a new image set is created; otherwise, the operation is performed in-place.

setCreateNew()

void setCreateNew

(

bool

value

)

Set whether to create a new image instead of performing an in-place operation.

If true, a new image set is created; otherwise, the operation is performed in-place.

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.

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note

Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from Algorithm.

---

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

• ImFusion/US/SweepCroppingAlgorithm.h