casa  \$Rev:20696\$
casa::StokesVector Class Reference

`#include <StokesVector.h>`

Inheritance diagram for casa::StokesVector:

List of all members.

## Public Member Functions

StokesVector ()
StokesVector(Int n):RigidVector<Float,4>(n) {} Default constructor zeroes vector.
StokesVector (Float f)
Construct from scalar, setting all values to a constant.
StokesVector (Float v0, Float v1, Float v2, Float v3)
Construct with four values specified.
StokesVector (const StokesVector &v)
Construct from Vector (should have length 4) StokesVector(const Vector<Float> & v):RigidVector<Float,4>(v) {} Copy constructor with copy semantics.
StokesVectoroperator= (const StokesVector &v)
Construct from RigidVector StokesVector(const RigidVector<Float,4>& v):RigidVector<Float,4>(v) {} Assignment.
StokesVectoroperator= (const Vector< Float > &v)
Assign from a Vector.
StokesVectoroperator= (Float f)
Assign from a scalar, setting all values to a constant.
StokesVectoroperator- ()
Negation.
StokesVectoroperator+= (const StokesVector &v)
StokesVectoroperator-= (const StokesVector &v)
Subtraction.
StokesVectoroperator*= (Float f)
StokesVectoroperator*= (const StokesVector &v)
StokesVectoroperator*= (const SquareMatrix< Float, 4 > &m)
Matrix multiplication - v*=m is equivalent to v=m*v.
Bool operator== (const StokesVector &v) const
Equality.
Bool operator!= (const StokesVector &v) const
Inequality.
Float maxEigenValue () const
Compute the maximum EigenValue.
Float minEigenValue () const
Compute the minimum EigenValue.
Float determinant () const
Compute the determinant of the coherence matrix.

## Static Public Member Functions

static String dataTypeId ()

## Friends

Float innerProduct (const StokesVector &l, const StokesVector &r)
The innerproduct of 2 StokesVectors.
CStokesVector operator* (const SquareMatrix< Complex, 4 > &m, const StokesVector &v)
Multiplication of StokesVector by a Complex SquareMatrix.
ostream & operator<< (ostream &os, const StokesVector &v)
Write out a StokesVector using the Vector output method.

## Detailed Description

Definition at line 228 of file StokesVector.h.

## Constructor & Destructor Documentation

 casa::StokesVector::StokesVector ( ) ` [inline]`

StokesVector(Int n):RigidVector<Float,4>(n) {} Default constructor zeroes vector.

Definition at line 234 of file StokesVector.h.

 casa::StokesVector::StokesVector ( Float f ) ` [inline]`

Construct from scalar, setting all values to a constant.

Definition at line 236 of file StokesVector.h.

 casa::StokesVector::StokesVector ( Float v0, Float v1, Float v2, Float v3 ) ` [inline]`

Construct with four values specified.

Definition at line 238 of file StokesVector.h.

 casa::StokesVector::StokesVector ( const StokesVector & v ) ` [inline]`

Construct from Vector (should have length 4) StokesVector(const Vector<Float> & v):RigidVector<Float,4>(v) {} Copy constructor with copy semantics.

Definition at line 242 of file StokesVector.h.

## Member Function Documentation

 static String casa::StokesVector::dataTypeId ( ) ` [inline, static]`

Definition at line 231 of file StokesVector.h.

 Float casa::StokesVector::determinant ( ) const

Compute the determinant of the coherence matrix.

 Float casa::StokesVector::maxEigenValue ( ) const

Compute the maximum EigenValue.

 Float casa::StokesVector::minEigenValue ( ) const

Compute the minimum EigenValue.

 Bool casa::StokesVector::operator!= ( const StokesVector & v ) const` [inline]`

Inequality.

Definition at line 285 of file StokesVector.h.

References casa::RigidVector< Float, 4 >::v_p, and casa::RigidVector< T, n >::v_p.

 StokesVector& casa::StokesVector::operator*= ( Float f ) ` [inline]`

Definition at line 269 of file StokesVector.h.

Referenced by operator*=().

 StokesVector& casa::StokesVector::operator*= ( const StokesVector & v ) ` [inline]`

Definition at line 272 of file StokesVector.h.

References operator*=().

 StokesVector& casa::StokesVector::operator*= ( const SquareMatrix< Float, 4 > & m ) ` [inline]`

Matrix multiplication - v*=m is equivalent to v=m*v.

Definition at line 276 of file StokesVector.h.

References operator*=().

 StokesVector& casa::StokesVector::operator+= ( const StokesVector & v ) ` [inline]`

Definition at line 262 of file StokesVector.h.

 StokesVector& casa::StokesVector::operator- ( ) ` [inline]`

Negation.

Reimplemented from casa::RigidVector< Float, 4 >.

Definition at line 258 of file StokesVector.h.

 StokesVector& casa::StokesVector::operator-= ( const StokesVector & v ) ` [inline]`

Subtraction.

Definition at line 266 of file StokesVector.h.

 StokesVector& casa::StokesVector::operator= ( const StokesVector & v ) ` [inline]`

Construct from RigidVector StokesVector(const RigidVector<Float,4>& v):RigidVector<Float,4>(v) {} Assignment.

Definition at line 246 of file StokesVector.h.

Referenced by operator=().

 StokesVector& casa::StokesVector::operator= ( const Vector< Float > & v ) ` [inline]`

Assign from a Vector.

Reimplemented from casa::RigidVector< Float, 4 >.

Definition at line 250 of file StokesVector.h.

References operator=().

 StokesVector& casa::StokesVector::operator= ( Float f ) ` [inline]`

Assign from a scalar, setting all values to a constant.

Definition at line 254 of file StokesVector.h.

References operator=().

 Bool casa::StokesVector::operator== ( const StokesVector & v ) const` [inline]`

Equality.

Definition at line 280 of file StokesVector.h.

References casa::RigidVector< Float, 4 >::v_p, and casa::RigidVector< T, n >::v_p.

## Friends And Related Function Documentation

 Float innerProduct ( const StokesVector & l, const StokesVector & r ) ` [friend]`

The innerproduct of 2 StokesVectors.

Definition at line 297 of file StokesVector.h.

 CStokesVector operator* ( const SquareMatrix< Complex, 4 > & m, const StokesVector & v ) ` [friend]`

Multiplication of StokesVector by a Complex SquareMatrix.

return m * (RigidVector<Float,4>&)v;

Definition at line 302 of file StokesVector.h.

 ostream& operator<< ( ostream & os, const StokesVector & v ) ` [friend]`

Write out a StokesVector using the Vector output method.

Definition at line 308 of file StokesVector.h.

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