gstlrn::ShapeHalfSinusoid Class Reference

#include <ShapeHalfSinusoid.hpp>

Inheritance diagram for gstlrn::ShapeHalfSinusoid:

Public Member Functions
	ShapeHalfSinusoid (double proportion=1., double period=10., double amplitude=1., double thickness=1., double xext=1., double zext=1., double theta=0.)
	ShapeHalfSinusoid (const ShapeHalfSinusoid &r)
ShapeHalfSinusoid &	operator= (const ShapeHalfSinusoid &r)
virtual	~ShapeHalfSinusoid ()
EShape	getType () const override
	Interface for ICloneable.
Id	getNParams () const override
bool	getFlagCutZ () const override
BooleanObject *	generateObject (Id ndim=3) override
bool	belongObject (const 1 &coor, const BooleanObject *object) const override
Public Member Functions inherited from gstlrn::AShape
	AShape ()
	AShape (const AShape &r)
AShape &	operator= (const AShape &r)
virtual	~AShape ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.
double	getFactorX2Y () const
double	getFactorX2Z () const
double	getFactorY2Z () const
double	getProportion () const
String	getParamName (Id ipar) const
double	getParam (Id ipar, Id iarg) const
const ShapeParameter &	getParam (Id ipar) const
void	setFactorX2Y (double factorX2Y)
void	setFactorX2Z (double factorX2Z)
void	setFactorY2Z (double factorY2Z)
void	setProportion (double proportion)
void	setParamName (Id ipar, const String &name)
void	setParam (Id ipar, Id iarg, double value)
void	setParamDefault (Id ipar, const String &name, double value)
void	setLaw (Id ipar, const ELaw &law)
void	initParams (Id count)
double	generateParam (Id ipar) 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
void	printConcreteClassName () const
Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0
std::shared_ptr< ICloneable >	cloneShared () const
std::unique_ptr< ICloneable >	cloneUnique () const

Constructor & Destructor Documentation

ShapeHalfSinusoid() [1/2]

gstlrn::ShapeHalfSinusoid::ShapeHalfSinusoid	(	double	proportion = 1.,
		double	period = 10.,
		double	amplitude = 1.,
		double	thickness = 1.,
		double	xext = 1.,
		double	zext = 1.,
		double	theta = 0.
	)

ShapeHalfSinusoid() [2/2]

gstlrn::ShapeHalfSinusoid::ShapeHalfSinusoid

(

const ShapeHalfSinusoid &

r

)

~ShapeHalfSinusoid()

gstlrn::ShapeHalfSinusoid::~ShapeHalfSinusoid ( )

virtual

Member Function Documentation

belongObject()

bool gstlrn::ShapeHalfSinusoid::belongObject ( const 1 &  coor, const BooleanObject *  object  ) const

overridevirtual

Check if the pixel (x,y,z) belongs to the object

Returns

1 if the pixel is in the grain, 0 if it is in the pore

Implements gstlrn::AShape.

generateObject()

BooleanObject * gstlrn::ShapeHalfSinusoid::generateObject ( Id  ndim = 3 )

overridevirtual

Generate the geometry of the object

Parameters

[in]

ndim

Space dimension

Implements gstlrn::AShape.

getFlagCutZ()

bool gstlrn::ShapeHalfSinusoid::getFlagCutZ ( ) const

inlineoverridevirtual

Implements gstlrn::AShape.

getNParams()

Id gstlrn::ShapeHalfSinusoid::getNParams ( ) const

inlineoverridevirtual

Implements gstlrn::AShape.

getType()

EShape gstlrn::ShapeHalfSinusoid::getType ( ) const

inlineoverridevirtual

Interface for ICloneable.

Implements gstlrn::AShape.

operator=()

ShapeHalfSinusoid & gstlrn::ShapeHalfSinusoid::operator=

(

const ShapeHalfSinusoid &

r

)

---

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

• include/Boolean/ShapeHalfSinusoid.hpp
• src/Boolean/ShapeHalfSinusoid.cpp