SpatialIndices Class Reference

#include <SpatialIndices.hpp>

Inheritance diagram for SpatialIndices:

Public Member Functions
	SpatialIndices (Db *db)
	SpatialIndices (const SpatialIndices &r)
SpatialIndices &	operator= (const SpatialIndices &r)
virtual	~SpatialIndices ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...
int	computeCGI (const String &name)
void	spatial (const String &name)
	Calculate several Spatial indices. More...
double	getLIC (const String &name1, const String &name2)
double	getGIC (const String &name1, const String &name2)
MatrixRectangular	getMatrixEllipse () const
MatrixRectangular	getMatrixInertia () const
VectorVectorDouble	getAxes () const
VectorDouble	getAxe (int rank) const
const VectorDouble &	getCenter () const
double	getInertia () const
double	getIso () const
VectorVectorDouble	getQT (const String &name) const
double	getMicroStructure (const String &name, double h0, const Polygons *polygon=nullptr, double dlim=0., int ndisc=100)
std::vector< SpacePoint >	getPatches (const String &name, double Dmin, double Amin=0)
Public Member Functions inherited from AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (int level) const final

Constructor & Destructor Documentation

SpatialIndices() [1/2]

SpatialIndices::SpatialIndices

(

Db *

db

)

SpatialIndices() [2/2]

SpatialIndices::SpatialIndices

(

const SpatialIndices &

r

)

~SpatialIndices()

SpatialIndices::~SpatialIndices ( )

virtual

Member Function Documentation

computeCGI()

int SpatialIndices::computeCGI

(

const String &

name

)

Calculate the Center of Gravity

Returns

Error returned code

Parameters

[in]

name

Name of the optional attribute

getAxe()

VectorDouble SpatialIndices::getAxe

(

int

rank

)

const

getAxes()

VectorVectorDouble SpatialIndices::getAxes

(

)

const

getCenter()

const VectorDouble& SpatialIndices::getCenter ( ) const

inline

getGIC()

double SpatialIndices::getGIC	(	const String &	name1,
		const String &	name2
	)

getInertia()

double SpatialIndices::getInertia ( ) const

inline

getIso()

double SpatialIndices::getIso ( ) const

inline

getLIC()

double SpatialIndices::getLIC	(	const String &	name1,
		const String &	name2
	)

getMatrixEllipse()

MatrixRectangular SpatialIndices::getMatrixEllipse

(

)

const

getMatrixInertia()

MatrixRectangular SpatialIndices::getMatrixInertia

(

)

const

getMicroStructure()

double SpatialIndices::getMicroStructure	(	const String &	name,
		double	h0,
		const Polygons *	polygon = nullptr,
		double	dlim = 0.,
		int	ndisc = 100
	)

getPatches()

std::vector< SpacePoint > SpatialIndices::getPatches	(	const String &	name,
		double	Dmin,
		double	Amin = 0
	)

Returns the list of center of gravity of the different patches The last center of gravity is the global one

Parameters

name	Name of the target variable
Dmin	Minimum rejection distance between patches
Amin	Abundance percentage above which patches are displayed

getQT()

VectorVectorDouble SpatialIndices::getQT

(

const String &

name

)

const

operator=()

SpatialIndices & SpatialIndices::operator=

(

const SpatialIndices &

r

)

spatial()

void SpatialIndices::spatial

(

const String &

name

)

Calculate several Spatial indices.

Parameters

name	Name of the Target variable

Remarks

This functions have been developped in the scope of the UE

program Fisboat, DG-Fish, STREP #502572

toString()

String SpatialIndices::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

---

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

• include/Spatial/SpatialIndices.hpp
• src/Spatial/SpatialIndices.cpp