gstlrn::Plane Class Reference

#include <Plane.hpp>

Inheritance diagram for gstlrn::Plane:

Public Member Functions
	Plane ()
	Plane (const Plane &m)
Plane &	operator= (const Plane &m)
virtual	~Plane ()
String	toString (const AStringFormat *strfmt=nullptr) const override
const &	getCoor () const
void	setCoor (const 1 &coor)
double	getIntercept () const
void	setIntercept (double intercept)
double	getRndval () const
void	setRndval (double rndval)
double	getValue () const
void	setValue (double value)
void	setCoor (Id idim, double value)
double	getCoor (Id idim) const
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

Static Public Member Functions
static std::vector< Plane >	poissonPlanesGenerate (DbGrid *dbgrid, Id np)

Constructor & Destructor Documentation

Plane() [1/2]

gstlrn::Plane::Plane

(

)

Plane() [2/2]

gstlrn::Plane::Plane

(

const Plane &

m

)

~Plane()

gstlrn::Plane::~Plane ( )

virtual

Member Function Documentation

getCoor() [1/2]

const & gstlrn::Plane::getCoor ( ) const

inline

getCoor() [2/2]

double gstlrn::Plane::getCoor

(

Id

idim

)

const

getIntercept()

double gstlrn::Plane::getIntercept ( ) const

inline

getRndval()

double gstlrn::Plane::getRndval ( ) const

inline

getValue()

double gstlrn::Plane::getValue ( ) const

inline

operator=()

Plane & gstlrn::Plane::operator=

(

const Plane &

m

)

poissonPlanesGenerate()

std::vector< Plane > gstlrn::Plane::poissonPlanesGenerate ( DbGrid *  dbgrid, Id  np  )

static

Generate the Poisson planes that cover the grid

Parameters

[in]	dbgrid	Db corresponding to the target grid
[in]	np	Number of planes

Remarks

The array 'planes' contains successively a,b,c,d such that

ax + by + cz + d = 0

The valuation of each line is assigned a uniform value [0,1]

setCoor() [1/2]

void gstlrn::Plane::setCoor ( const 1 &  coor )

inline

setCoor() [2/2]

void gstlrn::Plane::setCoor	(	Id	idim,
		double	value
	)

setIntercept()

void gstlrn::Plane::setIntercept ( double  intercept )

inline

setRndval()

void gstlrn::Plane::setRndval ( double  rndval )

inline

setValue()

void gstlrn::Plane::setValue ( double  value )

inline

toString()

String gstlrn::Plane::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

• include/Basic/Plane.hpp
• src/Basic/Plane.cpp