glotzcluster::ShapeDescriptor Class Reference
[Cluster Analysis]

A common interface for all shape descriptors. More...

#include <ShapeDescriptor.h>

Inheritance diagram for glotzcluster::ShapeDescriptor:

List of all members.

Public Member Functions
	ShapeDescriptor ()
	Constructor.
	ShapeDescriptor (const ShapeDescriptor &)
	Copy constructor.
virtual	~ShapeDescriptor ()
	Destructor.
virtual ShapeDescriptor *	Clone ()
	Clone constructor.
virtual void	SetCluster (Cluster *)
	Sets the cluster.
Cluster *	GetCluster () const
	Gets the cluster.
virtual void	Update ()
	Updates the descriptor.
virtual void	Print ()
	Prints the vector to stdout.
virtual void	Print (std::ostream &)
	Prints the vector to a stream.
virtual double	ComputeDifference (ShapeDescriptor *)
	Computes the normalized difference between the vector and anther.
virtual double	ComputeProjection (ShapeDescriptor *)
	Computes the normalized projection of the vector onto another.
virtual double	ComputeDifferenceRaw (ShapeDescriptor *)
	Computes the unnormalized difference between the vector and another.
virtual double	ComputeProjectionRaw (ShapeDescriptor *)
	Computes the unnormalized projection of the vector onto another.
virtual double	ComputeMagnitude ()
	Computes the magnitude of the vector.
Protected Attributes
Cluster *	mCluster
	The cluster who's shape to describe.

---

Detailed Description

A common interface for all shape descriptors.

Author:

Aaron Keys

All shape descriptors have certain member functions in common. The all take clusters as input and all produce

---

Constructor & Destructor Documentation

glotzcluster::ShapeDescriptor::ShapeDescriptor

(

)

Constructor.

glotzcluster::ShapeDescriptor::ShapeDescriptor

(

const ShapeDescriptor &

s

)

Copy constructor.

Parameters:

s

is the shape descriptor to copy on construction

glotzcluster::ShapeDescriptor::~ShapeDescriptor

(

)

[virtual]

Destructor.

---

Member Function Documentation

ShapeDescriptor * glotzcluster::ShapeDescriptor::Clone

(

)

[virtual]

Clone constructor.

Reimplemented from glotzutil::Listable.

Reimplemented in glotzcluster::YlmCentroidShapeDescriptor.

void glotzcluster::ShapeDescriptor::SetCluster

(

Cluster *

cluster

)

[virtual]

Sets the cluster.

Parameters:

cluster

is the cluster who's shape to describe

Cluster * glotzcluster::ShapeDescriptor::GetCluster

(

)

const

Gets the cluster.

return the cluster who's shape is described by the shape descriptor

void glotzcluster::ShapeDescriptor::Update

(

)

[virtual]

Updates the descriptor.

Reimplemented in glotzcluster::FkCentroidShapeDescriptor, glotzcluster::FkCoefficientShapeDescriptor, glotzcluster::FkTransformShapeDescriptor, glotzcluster::YlInvariantShapeDescriptor, glotzcluster::YlmCentroidShapeDescriptor, glotzcluster::YlmCoefficientShapeDescriptor, and glotzcluster::YlmTransformShapeDescriptor.

void glotzcluster::ShapeDescriptor::Print

(

)

[virtual]

Prints the vector to stdout.

Reimplemented in glotzcluster::ComplexShapeDescriptor, glotzcluster::RealShapeDescriptor, and glotzcluster::YlmCentroidShapeDescriptor.

void glotzcluster::ShapeDescriptor::Print

(

std::ostream &

os

)

[virtual]

Prints the vector to a stream.

Parameters:

os

the the ostream to print to

Reimplemented in glotzcluster::ComplexShapeDescriptor, and glotzcluster::RealShapeDescriptor.

double glotzcluster::ShapeDescriptor::ComputeDifference

(

ShapeDescriptor *

)

[virtual]

Computes the normalized difference between the vector and anther.

Reimplemented in glotzcluster::ComplexShapeDescriptor, and glotzcluster::RealShapeDescriptor.

double glotzcluster::ShapeDescriptor::ComputeProjection

(

ShapeDescriptor *

)

[virtual]

Computes the normalized projection of the vector onto another.

Reimplemented in glotzcluster::ComplexShapeDescriptor, and glotzcluster::RealShapeDescriptor.

double glotzcluster::ShapeDescriptor::ComputeDifferenceRaw

(

ShapeDescriptor *

)

[virtual]

Computes the unnormalized difference between the vector and another.

Reimplemented in glotzcluster::ComplexShapeDescriptor, and glotzcluster::RealShapeDescriptor.

double glotzcluster::ShapeDescriptor::ComputeProjectionRaw

(

ShapeDescriptor *

)

[virtual]

Computes the unnormalized projection of the vector onto another.

Reimplemented in glotzcluster::ComplexShapeDescriptor, and glotzcluster::RealShapeDescriptor.

double glotzcluster::ShapeDescriptor::ComputeMagnitude

(

)

[virtual]

Computes the magnitude of the vector.

Reimplemented in glotzcluster::ComplexShapeDescriptor, and glotzcluster::RealShapeDescriptor.

---

Member Data Documentation

Cluster* glotzcluster::ShapeDescriptor::mCluster [protected]

The cluster who's shape to describe.

---

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

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

---