casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Friends | List of all members
casa::StokesVector Class Reference

#include <StokesVector.h>

Inheritance diagram for casa::StokesVector:
casacore::RigidVector< casacore::Float, 4 >

Public Member Functions

 StokesVector ()
 StokesVector(casacore::Int n):RigidVector<casacore::Float,4>(n) {} Default constructor zeroes vector. More...
 
 StokesVector (casacore::Float f)
 Construct from scalar, setting all values to a constant. More...
 
 StokesVector (casacore::Float v0, casacore::Float v1, casacore::Float v2, casacore::Float v3)
 Construct with four values specified. More...
 
 StokesVector (const StokesVector &v)
 Construct from casacore::Vector (should have length 4) StokesVector(const casacore::Vector<casacore::Float> & v):RigidVector<casacore::Float,4>(v) {} Copy constructor with copy semantics. More...
 
StokesVectoroperator= (const StokesVector &v)
 Construct from RigidVector StokesVector(const casacore::RigidVector<casacore::Float,4>& v):RigidVector<casacore::Float,4>(v) {} Assignment. More...
 
StokesVectoroperator= (const casacore::Vector< casacore::Float > &v)
 Assign from a Vector. More...
 
StokesVectoroperator= (casacore::Float f)
 Assign from a scalar, setting all values to a constant. More...
 
StokesVectoroperator- ()
 Negation. More...
 
StokesVectoroperator+= (const StokesVector &v)
 Addition. More...
 
StokesVectoroperator-= (const StokesVector &v)
 Subtraction. More...
 
StokesVectoroperator*= (casacore::Float f)
 
StokesVectoroperator*= (const StokesVector &v)
 
StokesVectoroperator*= (const casacore::SquareMatrix< casacore::Float, 4 > &m)
 casacore::Matrix multiplication - v*=m is equivalent to v=m*v More...
 
casacore::Bool operator== (const StokesVector &v) const
 Equality. More...
 
casacore::Bool operator!= (const StokesVector &v) const
 Inequality. More...
 
casacore::Float maxEigenValue () const
 Compute the maximum EigenValue. More...
 
casacore::Float minEigenValue () const
 Compute the minimum EigenValue. More...
 
casacore::Float determinant () const
 Compute the determinant of the coherence matrix. More...
 
- Public Member Functions inherited from casacore::RigidVector< casacore::Float, 4 >
RigidVector< casacore::Float, n > & operator- ()
 Negation. More...
 
 RigidVector ()
 RigidVector(Int dummy) { for (Int i=0; i<n; i++) v_p[i]=T(0); } Default constructor. More...
 
 RigidVector (const casacore::Float &c)
 Construct from scalar, sets all elements to c. More...
 
 RigidVector (const casacore::Float &v0, const casacore::Float &v1)
 Construct a 2-element vector, fails for wrong size vectors. More...
 
 RigidVector (const casacore::Float &v0, const casacore::Float &v1, const casacore::Float &v2)
 Construct a 3-element vector, fails for wrong size vectors. More...
 
 RigidVector (const casacore::Float &v0, const casacore::Float &v1, const casacore::Float &v2, const casacore::Float &v3)
 Construct a 4-element vector, fails for wrong size vectors. More...
 
 RigidVector (const casacore::Float &v0, const casacore::Float &v1, const casacore::Float &v2, const casacore::Float &v3, const casacore::Float &v4)
 Construct a 5-element vector, fails for wrong size vectors. More...
 
 RigidVector (const casacore::Float &v0, const casacore::Float &v1, const casacore::Float &v2, const casacore::Float &v3, const casacore::Float &v4, const casacore::Float &v5)
 Construct a 6-element vector, fails for wrong size vectors. More...
 
 RigidVector (const casacore::Floatv[n])
 Construct from a c-array (copy semantics) More...
 
 RigidVector (const Vector< casacore::Float > &v)
 Construct from a Vector. More...
 
 RigidVector (const RigidVector< casacore::Float, n > &v)
 Copy constructor, copy semantics. More...
 
RigidVector< casacore::Float, n > & operator= (const RigidVector< casacore::Float, n > &v)
 Assign from a RigidVector. More...
 
RigidVector< casacore::Float, n > & operator= (const Vector< casacore::Float > &v)
 Assign from a Vector. More...
 
RigidVector< casacore::Float, n > & operator= (const casacore::Float &c)
 Assign a scalar, sets all elements to c. More...
 
RigidVector< casacore::Float, n > & operator+= (const RigidVector< casacore::Float, n > &v)
 Addition. More...
 
RigidVector< casacore::Float, n > & operator*= (const RigidVector< casacore::Float, n > &v)
 
RigidVector< casacore::Float, n > & operator*= (const casacore::Float &val)
 Multiplication by scalar. More...
 
RigidVector< casacore::Float, n > & operator*= (const SquareMatrix< casacore::Float, n > &m)
 Multiply vector by matrix: v*=M is equivalent to v=M*v;. More...
 
RigidVector< casacore::Float, n > & operator-= (const RigidVector< casacore::Float, n > &v)
 Subtraction. More...
 
casacore::Floatoperator() (Int i)
 Indexing by reference. More...
 
const casacore::Floatoperator() (Int i) const
 Indexing by const reference. More...
 
Vector< casacore::Floatvector () const
 Convert to a regular Vector. More...
 
RigidVector< casacore::Float, n > sqrt (const RigidVector< casacore::Float, n > &v)
 Square Root. More...
 

Static Public Member Functions

static casacore::String dataTypeId ()
 

Friends

casacore::Float innerProduct (const StokesVector &l, const StokesVector &r)
 The innerproduct of 2 StokesVectors. More...
 
std::ostream & operator<< (std::ostream &os, const StokesVector &v)
 Write out a StokesVector using the casacore::Vector output method. More...
 

Additional Inherited Members

- Protected Attributes inherited from casacore::RigidVector< casacore::Float, 4 >
casacore::Float v_p [n]
 // The following are needed for Image<RigidVector> More...
 

Detailed Description

Definition at line 232 of file StokesVector.h.

Constructor & Destructor Documentation

casa::StokesVector::StokesVector ( )
inline

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

Definition at line 238 of file StokesVector.h.

casa::StokesVector::StokesVector ( casacore::Float  f)
inline

Construct from scalar, setting all values to a constant.

Definition at line 240 of file StokesVector.h.

casa::StokesVector::StokesVector ( casacore::Float  v0,
casacore::Float  v1,
casacore::Float  v2,
casacore::Float  v3 
)
inline

Construct with four values specified.

Definition at line 242 of file StokesVector.h.

casa::StokesVector::StokesVector ( const StokesVector v)
inline

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

Definition at line 246 of file StokesVector.h.

Member Function Documentation

static casacore::String casa::StokesVector::dataTypeId ( )
inlinestatic

Definition at line 235 of file StokesVector.h.

casacore::Float casa::StokesVector::determinant ( ) const

Compute the determinant of the coherence matrix.

casacore::Float casa::StokesVector::maxEigenValue ( ) const

Compute the maximum EigenValue.

casacore::Float casa::StokesVector::minEigenValue ( ) const

Compute the minimum EigenValue.

casacore::Bool casa::StokesVector::operator!= ( const StokesVector v) const
inline
StokesVector& casa::StokesVector::operator*= ( casacore::Float  f)
inline

Definition at line 273 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator*=().

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

Definition at line 276 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator*=().

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

casacore::Matrix multiplication - v*=m is equivalent to v=m*v

Definition at line 280 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator*=().

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

Addition.

Definition at line 266 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator+=().

StokesVector& casa::StokesVector::operator- ( )
inline

Negation.

Definition at line 262 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator-().

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

Subtraction.

Definition at line 270 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator-=().

StokesVector& casa::StokesVector::operator= ( const StokesVector v)
inline

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

Definition at line 250 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator=().

StokesVector& casa::StokesVector::operator= ( const casacore::Vector< casacore::Float > &  v)
inline

Assign from a Vector.

Definition at line 254 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator=().

StokesVector& casa::StokesVector::operator= ( casacore::Float  f)
inline

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

Definition at line 258 of file StokesVector.h.

References casacore::RigidVector< T, n >::operator=().

casacore::Bool casa::StokesVector::operator== ( const StokesVector v) const
inline

Friends And Related Function Documentation

casacore::Float innerProduct ( const StokesVector l,
const StokesVector r 
)
friend

The innerproduct of 2 StokesVectors.

Definition at line 301 of file StokesVector.h.

std::ostream& operator<< ( std::ostream &  os,
const StokesVector v 
)
friend

Write out a StokesVector using the casacore::Vector output method.

Definition at line 306 of file StokesVector.h.


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