ccmc::Fieldline Class Reference

#include <ccmc/Fieldline.h>

Collaboration diagram for ccmc::Fieldline:

Public Member Functions
	Fieldline ()
	Fieldline (int initialSize)
	~Fieldline ()
void	insertPointData (const Point3f &p, const float &d)
void	insertVectorData (const Point3f &vector)
void	removePoint (int index)
Fieldline	reverseOrder ()
void	reverseOrderInPlace ()
const std::vector< Point3f > &	getPositions ()
const std::vector< float > &	getData ()
int	size ()
const Point3f &	getPosition (int i)
float	getData (int i)
Point3f	getStartPoint ()
int	getStartIndex ()
void	reserve (int size)
void	setStartPoint (Point3f p)
void	setStartIndex (int index)
void	setVariable (std::string variable)
const std::string &	getVariable ()
const std::vector< float > &	getDs ()
const std::vector< Point3f > &	getElements ()
const Point3f &	getElement (int i)
const std::vector< float > &	integrate ()
const std::vector< float > &	integrateVector ()
const std::vector< float > &	derivative ()
const std::vector< float > &	measure ()
float	getLength (int i)
float	getIntegral (int i)
Fieldline	interpolate (int option, int Npoints)
const std::vector< int > &	getNearest ()
const std::vector< float > &	getTlocal ()
void	minmax ()

Public Attributes
int	mincount
int	maxcount
std::vector< int >	minima
std::vector< int >	maxima
int	GlobMinIndex
int	GlobMaxIndex

Constructor & Destructor Documentation

ccmc::Fieldline::Fieldline

(

)

TODO: finish documentation

ccmc::Fieldline::Fieldline

(

int

initialSize

)

Parameters

initialSize

ccmc::Fieldline::~Fieldline

(

)

TODO: finish documentation

Member Function Documentation

const std::vector< float > & ccmc::Fieldline::derivative

(

)

Calculate the derivative of d values/ ds over the length of the field line

Here is the call graph for this function:

const std::vector< float > & ccmc::Fieldline::getData

(

)

TODO: finish documentation

Returns

float ccmc::Fieldline::getData

(

int

i

)

TODO: finish documentation

Parameters

i

Returns

const std::vector< float > & ccmc::Fieldline::getDs

(

)

Calculate the forward difference elements for a field line with ordered positions. Output has length fieldline.size()-1 TODO: Add backward and higher-order differencing

Here is the call graph for this function:

const Point3f & ccmc::Fieldline::getElement

(

int

i

)

const std::vector< Point3f > & ccmc::Fieldline::getElements

(

)

float ccmc::Fieldline::getIntegral

(

int

i

)

Get the integral up to position i

float ccmc::Fieldline::getLength

(

int

i

)

Get the length up to position i

Here is the call graph for this function:

const std::vector< int > & ccmc::Fieldline::getNearest

(

)

const Point3f & ccmc::Fieldline::getPosition

(

int

i

)

TODO: finish documentation

Parameters

i

Returns

const std::vector< Point3f > & ccmc::Fieldline::getPositions

(

)

TODO: finish documentation

Returns

int ccmc::Fieldline::getStartIndex

(

)

Point3f ccmc::Fieldline::getStartPoint

(

)

TODO: finish documentation

const std::vector< float > & ccmc::Fieldline::getTlocal

(

)

const std::string & ccmc::Fieldline::getVariable

(

)

void ccmc::Fieldline::insertPointData	(	const Point3f &	p,
		const float &	d
	)

TODO: finish documentation

Parameters

p
d

void ccmc::Fieldline::insertVectorData

(

const Point3f &

vector

)

const std::vector< float > & ccmc::Fieldline::integrate

(

)

Calculate the integral of ds*values over the length of the field line

Integration uses trapezoidal rule: multiplies the element lengths by the average of the data on either side of the segment

Here is the call graph for this function:

const std::vector< float > & ccmc::Fieldline::integrateVector

(

)

Calculate the integral of (vector) dot dl over the length of the field line

Here is the call graph for this function:

Fieldline ccmc::Fieldline::interpolate	(	int	option,
		int	Npoints
	)

Here is the call graph for this function:

const std::vector< float > & ccmc::Fieldline::measure

(

)

Measure the length of the field line up to point i

Here is the call graph for this function:

void ccmc::Fieldline::minmax

(

)

Here is the call graph for this function:

void ccmc::Fieldline::removePoint

(

int

index

)

TODO: finish documentation

Parameters

index

void ccmc::Fieldline::reserve

(

int

size

)

Parameters

size

Fieldline ccmc::Fieldline::reverseOrder

(

)

TODO: finish documentation

Returns

Here is the call graph for this function:

void ccmc::Fieldline::reverseOrderInPlace

(

)

TODO: finish documentation

Returns

Here is the call graph for this function:

void ccmc::Fieldline::setStartIndex

(

int

index

)

void ccmc::Fieldline::setStartPoint

(

Point3f

startPoint

)

TODO: finish documentation

Parameters

startPoint

void ccmc::Fieldline::setVariable

(

std::string

variable

)

int ccmc::Fieldline::size

(

)

TODO: finish documentation

Returns

Member Data Documentation

int ccmc::Fieldline::GlobMaxIndex

int ccmc::Fieldline::GlobMinIndex

int ccmc::Fieldline::maxcount

std::vector< int> ccmc::Fieldline::maxima

int ccmc::Fieldline::mincount

std::vector< int> ccmc::Fieldline::minima

---

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

• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Fieldline.h
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Fieldline.cpp