A Sampler class for longitudinal sampling. More...

#include <Longitude2DSampler.h>

Inheritance diagram for Longitude2DSampler:

Collaboration diagram for Longitude2DSampler:

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

	Longitude2DSampler (const Longitude2DSampler &other)

	Longitude2DSampler (Longitude2DSampler *sampler)

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

virtual	~Longitude2DSampler ()
	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/Get starting angle theta. More...

decimal	getStartTheta () const

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

decimal	getEndTheta () const

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

decimal	getStartPhi () const

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

decimal	getEndPhi () const

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	_deltaTheta

vec3	_nMin

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 longitudinal sampling.

Definition at line 32 of file Longitude2DSampler.h.

Constructor & Destructor Documentation

◆ Longitude2DSampler() [1/3]

Longitude2DSampler::Longitude2DSampler	(	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 Longitude2DSampler.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Longitude2DSampler() [2/3]

Longitude2DSampler::Longitude2DSampler ( const Longitude2DSampler & other )

inline

Definition at line 45 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ Longitude2DSampler() [3/3]

Longitude2DSampler::Longitude2DSampler ( Longitude2DSampler * sampler )

inline

Definition at line 54 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ ~Longitude2DSampler()

virtual Longitude2DSampler::~Longitude2DSampler ( )

inlinevirtual

Destructor.

Definition at line 69 of file Longitude2DSampler.h.

Member Function Documentation

◆ Clone()

virtual Sampler* Longitude2DSampler::Clone ( )

inlinevirtual

Clone a sample.

Reimplemented from Sampler.

Definition at line 63 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ getEndPhi()

decimal Longitude2DSampler::getEndPhi ( ) const

inline

Definition at line 133 of file Longitude2DSampler.h.

◆ getEndTheta()

decimal Longitude2DSampler::getEndTheta ( ) const

inline

Definition at line 113 of file Longitude2DSampler.h.

◆ getSample()

virtual vec3 Longitude2DSampler::getSample ( )

inlinevirtual

Return the sample.

Reimplemented from Sampler.

Definition at line 71 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ getStartPhi()

decimal Longitude2DSampler::getStartPhi ( ) const

inline

Definition at line 123 of file Longitude2DSampler.h.

◆ getStartTheta()

decimal Longitude2DSampler::getStartTheta ( ) const

inline

Definition at line 103 of file Longitude2DSampler.h.

◆ init()

virtual void Longitude2DSampler::init ( )

inlinevirtual

Initialize the sample.

Reimplemented from Sampler.

Definition at line 87 of file Longitude2DSampler.h.

Here is the caller graph for this function:

◆ isAcceptableSample()

virtual bool Longitude2DSampler::isAcceptableSample ( vec3 v )

inlinevirtual

Return true for an acceptable sample.

Reimplemented from Sampler.

Definition at line 83 of file Longitude2DSampler.h.

◆ setEndPhi()

void Longitude2DSampler::setEndPhi ( const decimal & endPhi )

inline

Set/Get ending angle phi.

Definition at line 128 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ setEndTheta()

void Longitude2DSampler::setEndTheta ( const decimal & endTheta )

inline

Set/Get ending angle theta.

Definition at line 108 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ setStartPhi()

void Longitude2DSampler::setStartPhi ( const decimal & startPhi )

inline

Set/Get starting angle phi.

Definition at line 118 of file Longitude2DSampler.h.

Here is the call graph for this function:

◆ setStartTheta()

void Longitude2DSampler::setStartTheta ( const decimal & startTheta )

inline

Set/Get starting angle theta.

Definition at line 98 of file Longitude2DSampler.h.

Here is the call graph for this function:

Member Data Documentation

◆ _deltaTheta

decimal Longitude2DSampler::_deltaTheta

private

Definition at line 143 of file Longitude2DSampler.h.

◆ _endPhi

decimal Longitude2DSampler::_endPhi

private

Definition at line 142 of file Longitude2DSampler.h.

◆ _endTheta

decimal Longitude2DSampler::_endTheta

private

Definition at line 140 of file Longitude2DSampler.h.

◆ _i

unsigned int Longitude2DSampler::_i

private

Definition at line 145 of file Longitude2DSampler.h.

◆ _nMin

vec3 Longitude2DSampler::_nMin

private

Definition at line 144 of file Longitude2DSampler.h.

◆ _startPhi

decimal Longitude2DSampler::_startPhi

private

Definition at line 141 of file Longitude2DSampler.h.

◆ _startTheta

decimal Longitude2DSampler::_startTheta

private

Definition at line 139 of file Longitude2DSampler.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Geometry/Longitude2DSampler.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Longitude2DSampler() [1/3]

◆ Longitude2DSampler() [2/3]

◆ Longitude2DSampler() [3/3]

◆ ~Longitude2DSampler()

Member Function Documentation

◆ Clone()

◆ getEndPhi()

◆ getEndTheta()

◆ getSample()

◆ getStartPhi()

◆ getStartTheta()

◆ init()

◆ isAcceptableSample()

◆ setEndPhi()

◆ setEndTheta()

◆ setStartPhi()

◆ setStartTheta()

Member Data Documentation

◆ _deltaTheta

◆ _endPhi

◆ _endTheta

◆ _i

◆ _nMin

◆ _startPhi

◆ _startTheta