glotzcluster::YlmCentroidShapeDescriptor Class Reference

#include <YlmCentroidShapeDescriptor.h>

Inheritance diagram for glotzcluster::YlmCentroidShapeDescriptor:

List of all members.

Public Member Functions
	YlmCentroidShapeDescriptor ()
	Constructor.
	YlmCentroidShapeDescriptor (const YlmCentroidShapeDescriptor &)
	Copy constructor.
YlmCentroidShapeDescriptor *	Clone ()
	Virtual constructor.
	~YlmCentroidShapeDescriptor ()
	Destructor.
void	SetHarmonicFrequency (short unsigned int)
	Define the set of spherical harmonics used.
void	SetL (short unsigned int)
	Define the set of spherical harmonics used.
void	Update ()
	Updates the vector.
double	ComputeQ ()
	Compute the second order invarient "Q".
double	ComputeInvariantO2 ()
	Compute the second order invarient "Q".
double	ComputeW ()
	Compute the third order invariant "W".
double	ComputeInvariantO3 ()
	Compute the third order invariant "W".
double	Dot (YlmCentroidShapeDescriptor &)
	Unnormalized Dot operator (same as projection).
double	RawDot (YlmCentroidShapeDescriptor &)
	Dot operator (same as projection).
void	Print ()
	Print contents to screen.
Protected Member Functions
void	ThreeJSymbolM (double, double, double, double, double &, double &, double *, int, int &)
	A function for computing the Wigner-3j symbol (based on code in MatPack).
Protected Attributes
short unsigned int	mL
	Print stream operator.

---

Constructor & Destructor Documentation

glotzcluster::YlmCentroidShapeDescriptor::YlmCentroidShapeDescriptor

(

)

Constructor.

glotzcluster::YlmCentroidShapeDescriptor::YlmCentroidShapeDescriptor

(

const YlmCentroidShapeDescriptor &

a

)

Copy constructor.

Parameters:

lhs

is the YlmCentroidShapeDescriptor on the right of = sign

glotzcluster::YlmCentroidShapeDescriptor::~YlmCentroidShapeDescriptor

(

)

Destructor.

---

Member Function Documentation

YlmCentroidShapeDescriptor * glotzcluster::YlmCentroidShapeDescriptor::Clone

(

)

[virtual]

Virtual constructor.

Reimplemented from glotzcluster::ShapeDescriptor.

void glotzcluster::YlmCentroidShapeDescriptor::SetHarmonicFrequency

(

short unsigned int

l

)

Define the set of spherical harmonics used.

Parameters:

l

is the harmonic frequency

See also:

SetL();

void glotzcluster::YlmCentroidShapeDescriptor::SetL

(

short unsigned int

l

)

Define the set of spherical harmonics used.

See also:

SetHarmonicFrequency();

void glotzcluster::YlmCentroidShapeDescriptor::Update

(

)

[virtual]

Updates the vector.

Reimplemented from glotzcluster::ShapeDescriptor.

double glotzcluster::YlmCentroidShapeDescriptor::ComputeQ

(

)

Compute the second order invarient "Q".

See also:

ComputeMagnitude()

Returns:

The second order invariant (i.e., the vector magnitude) "q"

double glotzcluster::YlmCentroidShapeDescriptor::ComputeInvariantO2

(

)

Compute the second order invarient "Q".

See also:

ComputeQ()

Returns:

The second order invariant (i.e., the normalized vector magnitude) "q"

double glotzcluster::YlmCentroidShapeDescriptor::ComputeW

(

)

Compute the third order invariant "W".

See also:

ComputeInvariantO3()

ComputeInvariantO3()

Returns:

The third order invariant "w"

double glotzcluster::YlmCentroidShapeDescriptor::ComputeInvariantO3

(

)

Compute the third order invariant "W".

See also:

ComputeInvariantO2()

Returns:

The second order invariant (i.e., the normalized vector magnitude) "q"

double glotzcluster::YlmCentroidShapeDescriptor::Dot

(

YlmCentroidShapeDescriptor &

rhs

)

Unnormalized Dot operator (same as projection).

double glotzcluster::YlmCentroidShapeDescriptor::RawDot

(

YlmCentroidShapeDescriptor &

rhs

)

Dot operator (same as projection).

Parameters:

rhs

is the YlmCentroidShapeDescriptor on the right of dot operator

void glotzcluster::YlmCentroidShapeDescriptor::Print

(

)

[virtual]

Print contents to screen.

Reimplemented from glotzcluster::ComplexShapeDescriptor.

void glotzcluster::YlmCentroidShapeDescriptor::ThreeJSymbolM	(	double	l1,
		double	l2,
		double	l3,
		double	m1,
		double &	m2min,
		double &	m2max,
		double *	thrcof,
		int	ndim,
		int &	errflag
	)			[protected]

A function for computing the Wigner-3j symbol (based on code in MatPack).

Note:

This function is from MatPack with a few modifications

Parameters:

	l1	is a parameter in 3j symbol
	l2	is a parameter in 3j symbol
	l3	is a parameter in 3j symbol
	m1	is a parameter in 3j symbol
	m2	is the smallest allowable m2 in 3j symbol
	m3	is the largest allowable m3 in 3j symbol
	thrcof	is the set of 3j coefficients generated by evaluating the 3j symbol for all allowed values of m2. thrcof(i) will contain g(m2min+i-1), i=1,2,...,m2max-m2min+1
	ndim	is the declared length of thrcof in calling program.
	errflag	is the error flag errflag=0 No errors. errflag=1 Either l1.LT.ABS(M1) or l1+ABS(M1) non-integer. errflag=2 ABS(l1-l2).LE.l3.LE.l1+l2 not satisfied. errflag=3 l1+l2+l3 not an integer. errflag=4 m2max-m2min not an integer. errflag=5 m2max less than m2min. errflag=6 ndim less than m2max-m2min+1.

---

Member Data Documentation

short unsigned int glotzcluster::YlmCentroidShapeDescriptor::mL [protected]

Print stream operator.

Harmonic frequency l (defines the set of spherical harmonics used)

---

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

• Glotzilla/src/glotzcluster/trunk/SourceCode/YlmCentroidShapeDescriptor.h
• Glotzilla/src/glotzcluster/trunk/SourceCode/YlmCentroidShapeDescriptor.cpp

---