Unwrap Class Reference

Algorithm to unwrap phases vectors represented as vectors of Real values. More...

#include <Unwrap.h>

List of all members.

Public Member Functions
	Unwrap ()
	~Unwrap ()
void	process (const MatrixXR &phases, MatrixXR *unwrapped)

---

Detailed Description

Algorithm to unwrap phases vectors represented as vectors of Real values.

This class represents an object to unwrap vectors of phases. The algorithm takes as input N-point vectors of Real values and returns N-point vectors of Real values.

Unwrapping consists in removing phase jumps larger than Pi or smaller to -Pi.

Author:

Ricard Marxer

See also:

FFT

---

Constructor & Destructor Documentation

Unwrap

(

)

Constructs an unwrap object with the given inputSize.

~Unwrap

(

)

Destroys the algorithm and frees its resources.

---

Member Function Documentation

void process	(	const MatrixXR &	phases,
		MatrixXR *	unwrapped
	)

Performs the unwrapping on each of the rows of phases and puts the resulting unwrapped phases in the rows of unwrapped.

Parameters:

	phases	matrix of Real values.
	unwrapped	pointer to a matrix of Real values for the output. The matrix should have the same number of rows and columns as phases.

Note that if the output matrix is not of the required size it will be resized, reallocating a new memory space if necessary.

---

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

• Unwrap.h
• Unwrap.cpp