gstlrn::SpatialIndices Class Reference

#include <SpatialIndices.hpp>

Inheritance diagram for gstlrn::SpatialIndices:

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

Constructor & Destructor Documentation

SpatialIndices() [1/2]

gstlrn::SpatialIndices::SpatialIndices

(

Db *

db

)

SpatialIndices() [2/2]

gstlrn::SpatialIndices::SpatialIndices

(

const SpatialIndices &

r

)

~SpatialIndices()

gstlrn::SpatialIndices::~SpatialIndices ( )

virtual

Member Function Documentation

computeCGI()

Id gstlrn::SpatialIndices::computeCGI

(

const String &

name

)

Calculate the Center of Gravity

Returns

Error returned code

Parameters

[in]

name

Name of the optional attribute

getAxe()

gstlrn::SpatialIndices::getAxe

(

Id

rank

)

const

getAxes()

gstlrn::SpatialIndices::getAxes

(

)

const

getCenter()

const & gstlrn::SpatialIndices::getCenter ( ) const

inline

getGIC()

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

getInertia()

double gstlrn::SpatialIndices::getInertia ( ) const

inline

getIso()

double gstlrn::SpatialIndices::getIso ( ) const

inline

getLIC()

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

getMatrixEllipse()

MatrixDense gstlrn::SpatialIndices::getMatrixEllipse

(

)

const

getMatrixInertia()

MatrixDense gstlrn::SpatialIndices::getMatrixInertia

(

)

const

getMicroStructure()

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

getPatches()

std::vector< SpacePoint > gstlrn::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()

gstlrn::SpatialIndices::getQT

(

const String &

name

)

const

operator=()

SpatialIndices & gstlrn::SpatialIndices::operator=

(

const SpatialIndices &

r

)

spatial()

void gstlrn::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 gstlrn::SpatialIndices::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

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