FloatComplex Class Reference

Contains floating point real and imaginary values. More...

#include <ComplexData.h>

List of all members.

Public Member Functions

 FloatComplex ()
 FloatComplex (float real, float imaginary)
 FloatComplex (double real)
double operator[] (ComplexComponent component) const
float getMagnitude () const
float getPhase () const

Public Attributes

float mReal
float mImaginary


Detailed Description

Contains floating point real and imaginary values.

See also:
IntegerComplex

Definition at line 110 of file ComplexData.h.


Constructor & Destructor Documentation

FloatComplex::FloatComplex (  ) 

Creates an default FloatComplex object.

Definition at line 116 of file ComplexData.h.

FloatComplex::FloatComplex ( float  real,
float  imaginary 
)

Creates an FloatComplex object with initial values.

Parameters:
real The real or in-phase component value.
imaginary The imaginary or quadrature component value.

Definition at line 126 of file ComplexData.h.

FloatComplex::FloatComplex ( double  real  ) 

Definition at line 127 of file ComplexData.h.


Member Function Documentation

double FloatComplex::operator[] ( ComplexComponent  component  )  const

Definition at line 129 of file ComplexData.h.

float FloatComplex::getMagnitude (  )  const

Returns the magnitude of the data.

Returns:
The magnitude.

Definition at line 162 of file ComplexData.h.

float FloatComplex::getPhase (  )  const

Returns the phase angle of the data.

Returns:
The phase angle in radians.

Definition at line 173 of file ComplexData.h.


Member Data Documentation

Definition at line 179 of file ComplexData.h.

Definition at line 180 of file ComplexData.h.


Software Development Kit - Opticks 4.9.0 Build 16218