A Sampler class for latitude sampling. More...

#include <Latitude2DSampler.h>

Inheritance diagram for Latitude2DSampler:

Collaboration diagram for Latitude2DSampler:

Public Member Functions
	Latitude2DSampler (const unsigned int &nbRays=0, const decimal &Theta=(decimal) M_PIDIV2, const decimal &Phi=(decimal) M_2PI)
	Constructors. More...

	Latitude2DSampler (const Latitude2DSampler &other)

	Latitude2DSampler (Latitude2DSampler *sampler)

virtual Sampler *	Clone ()
	Clone a sample. More...

virtual	~Latitude2DSampler ()
	Destructor. More...

virtual vec3	getSample ()
	Return the sample. More...

virtual bool	isAcceptableSample (vec3 v)
	Return true for an acceptable sample. More...

virtual void	init ()
	Initialize the sample. More...

void	setStartTheta (const decimal &startTheta)
	Set starting angle theta. More...

decimal	getStartTheta () const
	Get starting angle theta. More...

void	setEndTheta (const decimal &endTheta)
	Set ending angle theta. More...

decimal	getEndTheta () const
	Get ending angle theta. More...

void	setStartPhi (const decimal &startPhi)
	Set starting angle phi. More...

decimal	getStartPhi () const
	Get starting angle phi. More...

void	setEndPhi (const decimal &endPhi)
	Set ending angle phi. More...

decimal	getEndPhi () const
	Get ending angle phi. More...

Public Member Functions inherited from Sampler
	Sampler (const unsigned int &nbRays=0, const decimal &Theta=(decimal) M_PIDIV2, const decimal &Phi=(decimal) M_2PI)
	Default constructor. More...

	Sampler (const Sampler &other)
	Copy constructors. More...

	Sampler (Sampler *sampler)

virtual	~Sampler ()
	Destructor. More...

virtual unsigned int	getNbRays () const
	Get/Set the number of rays to launch. More...

virtual void	setNbRays (const unsigned int &nbRays)

decimal	getTheta () const
	Get/Set the polar angle. More...

void	setTheta (const decimal &Theta)

decimal	getPhi () const
	Get/Set the equatorial polar angle. More...

void	setPhi (const decimal &Phi)

virtual unsigned int	computeDiffractionNbr (const decimal &theta)
	Return the number of rays to launch after a diffraction event. More...

Private Attributes
decimal	_startTheta

decimal	_endTheta

decimal	_startPhi

decimal	_endPhi

decimal	_deltaPhi

unsigned int	_i

Additional Inherited Members
Protected Attributes inherited from Sampler
unsigned int	_nb_rays
	Number of rays to launch. More...

decimal	_theta
	Global polar angle. More...

decimal	_phi
	Global equatorial angle. More...

Detailed Description

A Sampler class for latitude sampling.

Definition at line 32 of file Latitude2DSampler.h.

Constructor & Destructor Documentation

◆ Latitude2DSampler() [1/3]

Latitude2DSampler::Latitude2DSampler	(	const unsigned int &	nbRays = `0`,
		const decimal &	Theta = `(decimal) M_PIDIV2`,
		const decimal &	Phi = `(decimal) M_2PI`
	)

inline

Constructors.

Definition at line 37 of file Latitude2DSampler.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Latitude2DSampler() [2/3]

Latitude2DSampler::Latitude2DSampler ( const Latitude2DSampler & other )

inline

Definition at line 50 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ Latitude2DSampler() [3/3]

Latitude2DSampler::Latitude2DSampler ( Latitude2DSampler * sampler )

inline

Definition at line 59 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ ~Latitude2DSampler()

virtual Latitude2DSampler::~Latitude2DSampler ( )

inlinevirtual

Destructor.

Definition at line 74 of file Latitude2DSampler.h.

Member Function Documentation

◆ Clone()

virtual Sampler* Latitude2DSampler::Clone ( )

inlinevirtual

Clone a sample.

Reimplemented from Sampler.

Definition at line 68 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ getEndPhi()

decimal Latitude2DSampler::getEndPhi ( ) const

inline

Get ending angle phi.

Definition at line 114 of file Latitude2DSampler.h.

◆ getEndTheta()

decimal Latitude2DSampler::getEndTheta ( ) const

inline

Get ending angle theta.

Definition at line 106 of file Latitude2DSampler.h.

◆ getSample()

virtual vec3 Latitude2DSampler::getSample ( )

inlinevirtual

Return the sample.

Reimplemented from Sampler.

Definition at line 76 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ getStartPhi()

decimal Latitude2DSampler::getStartPhi ( ) const

inline

Get starting angle phi.

Definition at line 110 of file Latitude2DSampler.h.

◆ getStartTheta()

decimal Latitude2DSampler::getStartTheta ( ) const

inline

Get starting angle theta.

Definition at line 102 of file Latitude2DSampler.h.

◆ init()

virtual void Latitude2DSampler::init ( )

inlinevirtual

Initialize the sample.

Reimplemented from Sampler.

Definition at line 87 of file Latitude2DSampler.h.

Here is the caller graph for this function:

◆ isAcceptableSample()

virtual bool Latitude2DSampler::isAcceptableSample ( vec3 v )

inlinevirtual

Return true for an acceptable sample.

Reimplemented from Sampler.

Definition at line 86 of file Latitude2DSampler.h.

◆ setEndPhi()

void Latitude2DSampler::setEndPhi ( const decimal & endPhi )

inline

Set ending angle phi.

Definition at line 112 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ setEndTheta()

void Latitude2DSampler::setEndTheta ( const decimal & endTheta )

inline

Set ending angle theta.

Definition at line 104 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ setStartPhi()

void Latitude2DSampler::setStartPhi ( const decimal & startPhi )

inline

Set starting angle phi.

Definition at line 108 of file Latitude2DSampler.h.

Here is the call graph for this function:

◆ setStartTheta()

void Latitude2DSampler::setStartTheta ( const decimal & startTheta )

inline

Set starting angle theta.

Definition at line 100 of file Latitude2DSampler.h.

Here is the call graph for this function:

Member Data Documentation

◆ _deltaPhi

decimal Latitude2DSampler::_deltaPhi

private

Definition at line 121 of file Latitude2DSampler.h.

◆ _endPhi

decimal Latitude2DSampler::_endPhi

private

Definition at line 120 of file Latitude2DSampler.h.

◆ _endTheta

decimal Latitude2DSampler::_endTheta

private

Definition at line 118 of file Latitude2DSampler.h.

◆ _i

unsigned int Latitude2DSampler::_i

private

Definition at line 122 of file Latitude2DSampler.h.

◆ _startPhi

decimal Latitude2DSampler::_startPhi

private

Definition at line 119 of file Latitude2DSampler.h.

◆ _startTheta

decimal Latitude2DSampler::_startTheta

private

Definition at line 117 of file Latitude2DSampler.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Geometry/Latitude2DSampler.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Latitude2DSampler() [1/3]

◆ Latitude2DSampler() [2/3]

◆ Latitude2DSampler() [3/3]

◆ ~Latitude2DSampler()

Member Function Documentation

◆ Clone()

◆ getEndPhi()

◆ getEndTheta()

◆ getSample()

◆ getStartPhi()

◆ getStartTheta()

◆ init()

◆ isAcceptableSample()

◆ setEndPhi()

◆ setEndTheta()

◆ setStartPhi()

◆ setStartTheta()

Member Data Documentation

◆ _deltaPhi

◆ _endPhi

◆ _endTheta

◆ _i

◆ _startPhi

◆ _startTheta