PostFilter Class Reference

Class to apply a filter to the group of valid rays found by ray tracing. More...

#include <PostFilter.h>

Inheritance diagram for PostFilter:

Collaboration diagram for PostFilter:

Public Member Functions
	PostFilter (std::deque< Ray * > *tabRay)
	Constructor. More...
	~PostFilter ()
	Destructor. More...
virtual unsigned int	Process ()
	Apply a filter to the group of valid rays found by ray tracing. More...
virtual unsigned int	buildFamilies (families &mapFamilies, typeevent typeEv)
	Group rays with the same signature (same source and receptor events of same kind in the same order) More...
virtual void	rebuildTabRays (families &mapFamilies)
	Rebuild rays tab after treatment. More...
virtual sequenceMap	buildSequenceMap (const signature &sig, std::vector< Ray * > tabRay, const typeevent &evType)
	Sort rays by events of type evType encountered along is path. More...
decimal	minimum_distance (const decimal &thickness, const decimal &d_R) const
	compute minimum acceptable distance between two rays thickness is the thickness of a ray after a given distance d_R is the difference length between two rays More...
Public Member Functions inherited from Base
	Base ()
	Default constructor. More...
	Base (const Base &other)
	Copy constructor. More...
virtual	~Base ()
	Destructor. More...
std::string	getName ()
	Get the name of the object. More...
void	setName (const std::string &_name)
	Set the name of the object. More...

Protected Member Functions
virtual sequence	buildSequence (const signature &sig, Ray *ray, const typeevent &evType)
	Build the sequence of physical shape encountered by the ray. More...
virtual std::deque< Ray * >::iterator	erase_element (std::deque< Ray * > &tabRays, std::deque< Ray * >::iterator &iter)
	Delete an element in the rays array. More...

Protected Attributes
std::deque< Ray * > *	_tabRays
	Rays tab: pointers list of rays. More...
Protected Attributes inherited from Base
std::string	name
	Each instantiated object may be named. More...

Detailed Description

Class to apply a filter to the group of valid rays found by ray tracing.

Definition at line 30 of file PostFilter.h.

Constructor & Destructor Documentation

PostFilter()

PostFilter::PostFilter ( std::deque< Ray * > *  tabRay )

inline

Constructor.

Definition at line 34 of file PostFilter.h.

~PostFilter()

PostFilter::~PostFilter ( )

inline

Destructor.

Definition at line 36 of file PostFilter.h.

Member Function Documentation

buildFamilies()

virtual unsigned int PostFilter::buildFamilies ( families &  mapFamilies, typeevent  typeEv  )

inlinevirtual

Group rays with the same signature (same source and receptor events of same kind in the same order)

Returns

Number of families created

Definition at line 54 of file PostFilter.h.

buildSequence()

virtual sequence PostFilter::buildSequence ( const signature &  sig, Ray *  ray, const typeevent &  evType  )

inlineprotectedvirtual

Build the sequence of physical shape encountered by the ray.

Definition at line 114 of file PostFilter.h.

Here is the call graph for this function:

Here is the caller graph for this function:

buildSequenceMap()

virtual sequenceMap PostFilter::buildSequenceMap ( const signature &  sig, std::vector< Ray * >  tabRay, const typeevent &  evType  )

inlinevirtual

Sort rays by events of type evType encountered along is path.

Definition at line 86 of file PostFilter.h.

Here is the call graph for this function:

erase_element()

virtual std::deque<Ray*>::iterator PostFilter::erase_element ( std::deque< Ray * > &  tabRays, std::deque< Ray * >::iterator &  iter  )

inlineprotectedvirtual

Delete an element in the rays array.

Definition at line 129 of file PostFilter.h.

minimum_distance()

decimal PostFilter::minimum_distance ( const decimal &  thickness, const decimal &  d_R  ) const

inline

compute minimum acceptable distance between two rays thickness is the thickness of a ray after a given distance d_R is the difference length between two rays

Definition at line 105 of file PostFilter.h.

Process()

virtual unsigned int PostFilter::Process ( )

inlinevirtual

Apply a filter to the group of valid rays found by ray tracing.

Returns

number of rays suppressed

Definition at line 45 of file PostFilter.h.

rebuildTabRays()

virtual void PostFilter::rebuildTabRays ( families &  mapFamilies )

inlinevirtual

Rebuild rays tab after treatment.

Definition at line 67 of file PostFilter.h.

Member Data Documentation

_tabRays

std::deque<Ray*>* PostFilter::_tabRays

protected

Rays tab: pointers list of rays.

Definition at line 139 of file PostFilter.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/Tools/PostFilter.h