Base class for a spatial event (FMTsaevent or FMTsesevent): a set of FMTCoordinate corresponding to the coordinates present in the event. More...

#include <FMTEvent.h>

Public Member Functions
std::set< FMTCoordinate >::const_iterator	midPosition () const
	Get the mid point of the elements of the event.

	~FMTEvent ()=default
	Default destructor for FMTEvent.

	FMTEvent (const FMTEvent &rhs)=default
	Copy constructor for FMTEvent.

FMTEvent &	operator= (const FMTEvent &rhs)=default
	Copy assignment operator for FMTEvent.

	FMTEvent ()=default
	Default constructor for FMTEvent.

	FMTEvent (const FMTCoordinate &p_location, int p_actionId, int p_period, size_t p_centroidGraphFamily)
	Construct a FMTEvent from a location, an action id, a period and a centroid graph family.

bool	empty () const
	Test whether the event is empty.

size_t	size () const
	Return the size of the event.

size_t	hash () const
	Hash the event.

FMTEventRelation	getRelation (const FMTEvent &rhs) const
	Return the relation between this event and another one.

bool	operator== (const FMTEvent &rhs) const
	Comparison operator for FMTEvent.

bool	operator!= (const FMTEvent &rhs) const
	Comparison operator for FMTEvent.

bool	operator< (const FMTEvent &rhs) const
	Less than operator for FMTEvent.

size_t	perimeter () const
	Return the perimeter of the event, including any internal holes.

size_t	height () const
	Return the height of the event.

size_t	width () const
	Return the width of the event.

FMTCoordinate	averageCentroid () const
	Return the centroid based on the envelope of the event.

std::string	getStats () const
	Return the patch stats (size, perimeter, height and width) as a string.

virtual void	erase (const FMTCoordinate &newlocation)
	Erase a coordinate from the event.

virtual void	merge (const FMTEvent &event)
	Merge another event into this one.

virtual void	insert (const FMTCoordinate &newlocation)
	Insert a coordinate in the event.

void	setActionId (const int &laction_id)
	Set the action id of the event.

const int &	getActionId () const
	Return the action id of the event.

const int &	getPeriod () const
	Return the period of the event.

const size_t &	getGraphFamily () const
	Return the graph family of the event.

const std::set< FMTCoordinate > &	getElements () const
	Return the elements (coordinates) of the event.

virtual std::vector< std::set< FMTCoordinate >::const_iterator >	ignit (const size_t &eventmaximalsize, const std::set< FMTCoordinate >::const_iterator &ignit, int p_actionId, int p_period, size_t p_GraphFamily)
	Ignite the event at a coordinate for an action, a period and a graph family, up to a maximal size.

virtual bool	spread (const size_t &eventminimalsize, const size_t &eventmaximalsize, const size_t &neighboringsize, const std::set< FMTCoordinate > &territory, std::vector< std::set< FMTCoordinate >::const_iterator > active)
	Spread the event within a territory from the active coordinates, respecting the size bounds.

double	distance (const FMTEvent &rhs) const
	Return the distance between this event and another one.

template<typename T >
bool	within (const T &dist, const FMTEvent &rhs) const
	Return true if the event is within a distance of another event's envelope.

template<typename T >
bool	within (const T &dist, const FMTCoordinate &location) const
	Return true if a coordinate is within a distance of the event's coordinates.

bool	contain (const FMTCoordinate &coord) const
	Return true if a coordinate is in the elements of the event.

bool	willSplitEvent (const FMTCoordinate &p_coordinate) const
	Return true if removing a coordinate will split the event.

bool	splitEvent (std::vector< FMTEvent > &splittedevents) const
	Split the event, filling a vector with the split events and removing the elements from the current event.

std::set< FMTCoordinate >	getTerritory (const size_t &distance) const
	Return the adjacent territory of the event based on a distance.

std::vector< std::set< FMTCoordinate >::const_iterator >	getBorders () const
	Return the coordinates of the border of the event.

std::vector< std::pair< FMTCoordinate, FMTCoordinate > >	getOutsideBordersPair () const
	Return the outside borders of the event as pairs of coordinates.

std::array< FMTCoordinate, 4 >	getEnveloppe () const
	Return the four coordinates that create the envelope of the event.

void	getClosesCoordinates (const FMTEvent &rhs, std::set< FMTCoordinate >::const_iterator &thiscoordinate, std::set< FMTCoordinate >::const_iterator &rhscoordinate) const
	Return the closest coordinates between this event and another one.

Static Public Member Functions
static std::string	getStatsHeader ()
	Return the header of the patch stats (size, perimeter, height and width).

Friends
class	boost::serialization::access

Detailed Description

Base class for a spatial event (FMTsaevent or FMTsesevent): a set of FMTCoordinate corresponding to the coordinates present in the event.

Constructor & Destructor Documentation

◆ ~FMTEvent()

Spatial::FMTEvent::~FMTEvent ( )

default

Default destructor for FMTEvent.

◆ FMTEvent() [1/3]

Spatial::FMTEvent::FMTEvent ( const FMTEvent & rhs )

default

Copy constructor for FMTEvent.

Parameters

[in] rhs the FMTEvent to copy.

◆ FMTEvent() [2/3]

Spatial::FMTEvent::FMTEvent ( )

default

Default constructor for FMTEvent.

◆ FMTEvent() [3/3]

Spatial::FMTEvent::FMTEvent	(	const FMTCoordinate &	p_location,
		int	p_actionId,
		int	p_period,
		size_t	p_centroidGraphFamily
	)

Construct a FMTEvent from a location, an action id, a period and a centroid graph family.

Parameters

[in]	p_location	the location.
[in]	p_actionId	the action id.
[in]	p_period	the period.
[in]	p_centroidGraphFamily	the centroid graph family.

Member Function Documentation

◆ averageCentroid()

FMTCoordinate Spatial::FMTEvent::averageCentroid ( ) const

Return the centroid based on the envelope of the event.

Returns: the average centroid.

◆ contain()

bool Spatial::FMTEvent::contain ( const FMTCoordinate & coord ) const

Return true if a coordinate is in the elements of the event.

Parameters

[in] coord the coordinate.

Returns: true if the coordinate is in the event else false.

◆ distance()

double Spatial::FMTEvent::distance ( const FMTEvent & rhs ) const

Return the distance between this event and another one.

Parameters

[in] rhs the other event.

Returns: the distance.

◆ empty()

bool Spatial::FMTEvent::empty ( ) const

Test whether the event is empty.

Returns: true if the event is empty else false.

◆ erase()

virtual void Spatial::FMTEvent::erase ( const FMTCoordinate & newlocation )

virtual

Erase a coordinate from the event.

Parameters

[in] newlocation the coordinate to erase.

◆ getActionId()

const int & Spatial::FMTEvent::getActionId ( ) const

Return the action id of the event.

Returns: the action id.

◆ getBorders()

std::vector< std::set< FMTCoordinate >::const_iterator > Spatial::FMTEvent::getBorders ( ) const

Return the coordinates of the border of the event.

Returns: the border coordinates.

◆ getClosesCoordinates()

void Spatial::FMTEvent::getClosesCoordinates	(	const FMTEvent &	rhs,
		std::set< FMTCoordinate >::const_iterator &	thiscoordinate,
		std::set< FMTCoordinate >::const_iterator &	rhscoordinate
	)		const

Return the closest coordinates between this event and another one.

Parameters

[in]	rhs	the other event.
[out]	thiscoordinate	the closest coordinate of this event.
[out]	rhscoordinate	the closest coordinate of the other event.

◆ getElements()

const std::set< FMTCoordinate > & Spatial::FMTEvent::getElements ( ) const

Return the elements (coordinates) of the event.

Returns: the event elements.

◆ getEnveloppe()

std::array< FMTCoordinate, 4 > Spatial::FMTEvent::getEnveloppe ( ) const

Return the four coordinates that create the envelope of the event.

Returns: the envelope coordinates.

◆ getGraphFamily()

const size_t & Spatial::FMTEvent::getGraphFamily ( ) const

Return the graph family of the event.

Returns: the graph family.

◆ getOutsideBordersPair()

std::vector< std::pair< FMTCoordinate, FMTCoordinate > > Spatial::FMTEvent::getOutsideBordersPair ( ) const

Return the outside borders of the event as pairs of coordinates.

Returns: the outside border pairs.

◆ getPeriod()

const int & Spatial::FMTEvent::getPeriod ( ) const

Return the period of the event.

Returns: the period.

◆ getRelation()

FMTEventRelation Spatial::FMTEvent::getRelation ( const FMTEvent & rhs ) const

Return the relation between this event and another one.

Parameters

[in] rhs the other event.

Returns: the event relation.

◆ getStats()

std::string Spatial::FMTEvent::getStats ( ) const

Return the patch stats (size, perimeter, height and width) as a string.

Returns: the stats.

◆ getStatsHeader()

static std::string Spatial::FMTEvent::getStatsHeader ( )

static

Return the header of the patch stats (size, perimeter, height and width).

Returns: the stats header.

◆ getTerritory()

std::set< FMTCoordinate > Spatial::FMTEvent::getTerritory ( const size_t & distance ) const

Return the adjacent territory of the event based on a distance.

Parameters

[in] distance the distance.

Returns: the territory coordinates.

◆ hash()

size_t Spatial::FMTEvent::hash ( ) const

Hash the event.

Returns: the hash of the event.

◆ height()

size_t Spatial::FMTEvent::height ( ) const

Return the height of the event.

Returns: the height.

◆ ignit()

virtual std::vector< std::set< FMTCoordinate >::const_iterator > Spatial::FMTEvent::ignit	(	const size_t &	eventmaximalsize,
		const std::set< FMTCoordinate >::const_iterator &	ignit,
		int	p_actionId,
		int	p_period,
		size_t	p_GraphFamily
	)

virtual

Ignite the event at a coordinate for an action, a period and a graph family, up to a maximal size.

Parameters

[in]	eventmaximalsize	the maximal event size.
[in]	ignit	the ignition coordinate.
[in]	p_actionId	the action id.
[in]	p_period	the period.
[in]	p_GraphFamily	the graph family.

Returns: the active coordinates.

◆ insert()

virtual void Spatial::FMTEvent::insert ( const FMTCoordinate & newlocation )

virtual

Insert a coordinate in the event.

Parameters

[in] newlocation the coordinate to insert.

◆ merge()

virtual void Spatial::FMTEvent::merge ( const FMTEvent & event )

virtual

Merge another event into this one.

Parameters

[in] event the event to merge.

◆ midPosition()

std::set< FMTCoordinate >::const_iterator Spatial::FMTEvent::midPosition ( ) const

Get the mid point of the elements of the event.

Returns: an iterator to the mid coordinate.

◆ operator!=()

bool Spatial::FMTEvent::operator!= ( const FMTEvent & rhs ) const

Comparison operator for FMTEvent.

Parameters

[in] rhs the FMTEvent to compare to.

Returns: true if both events are different else false.

◆ operator<()

bool Spatial::FMTEvent::operator< ( const FMTEvent & rhs ) const

Less than operator for FMTEvent.

Parameters

[in] rhs the FMTEvent to compare to.

Returns: true if this event is less than the other else false.

◆ operator=()

FMTEvent & Spatial::FMTEvent::operator= ( const FMTEvent & rhs )

default

Copy assignment operator for FMTEvent.

Parameters

[in] rhs the FMTEvent to copy.

Returns: a reference to this FMTEvent.

◆ operator==()

bool Spatial::FMTEvent::operator== ( const FMTEvent & rhs ) const

Comparison operator for FMTEvent.

Parameters

[in] rhs the FMTEvent to compare to.

Returns: true if both events are equal else false.

◆ perimeter()

size_t Spatial::FMTEvent::perimeter ( ) const

Return the perimeter of the event, including any internal holes.

Returns: the perimeter.

◆ setActionId()

void Spatial::FMTEvent::setActionId ( const int & laction_id )

Set the action id of the event.

Parameters

[in] laction_id the action id.

◆ size()

size_t Spatial::FMTEvent::size ( ) const

Return the size of the event.

Returns: the event size.

◆ splitEvent()

bool Spatial::FMTEvent::splitEvent ( std::vector< FMTEvent > & splittedevents ) const

Split the event, filling a vector with the split events and removing the elements from the current event.

Parameters

[in,out] splittedevents the split events.

Returns: true if the event was split else false.

◆ spread()

virtual bool Spatial::FMTEvent::spread	(	const size_t &	eventminimalsize,
		const size_t &	eventmaximalsize,
		const size_t &	neighboringsize,
		const std::set< FMTCoordinate > &	territory,
		std::vector< std::set< FMTCoordinate >::const_iterator >	active
	)

virtual

Spread the event within a territory from the active coordinates, respecting the size bounds.

Parameters

[in]	eventminimalsize	the minimal event size.
[in]	eventmaximalsize	the maximal event size.
[in]	neighboringsize	the neighboring size.
[in]	territory	the territory to spread in.
[in]	active	the active coordinates.

Returns: true if the event spread within the bounds else false.

◆ width()

size_t Spatial::FMTEvent::width ( ) const

Return the width of the event.

Returns: the width.

◆ willSplitEvent()

bool Spatial::FMTEvent::willSplitEvent ( const FMTCoordinate & p_coordinate ) const

Return true if removing a coordinate will split the event.

Parameters

[in] p_coordinate the coordinate that will be removed.

Returns: true if it will split the event else false.

◆ within() [1/2]

template<typename T >

bool Spatial::FMTEvent::within	(	const T &	dist,
		const FMTCoordinate &	location
	)		const

Return true if a coordinate is within a distance of the event's coordinates.

Template Parameters

T	the distance type.

Parameters

[in]	dist	the distance.
[in]	location	the coordinate.

Returns: true if the coordinate is within the distance else false.

◆ within() [2/2]

template<typename T >

bool Spatial::FMTEvent::within	(	const T &	dist,
		const FMTEvent &	rhs
	)		const

Return true if the event is within a distance of another event's envelope.

Template Parameters

T	the distance type.

Parameters

[in]	dist	the distance.
[in]	rhs	the other event.

Returns: true if the event is within the distance else false.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

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

D:/FMT/Include/FMTEvent.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~FMTEvent()

◆ FMTEvent() [1/3]

◆ FMTEvent() [2/3]

◆ FMTEvent() [3/3]

Member Function Documentation

◆ averageCentroid()

◆ contain()

◆ distance()

◆ empty()

◆ erase()

◆ getActionId()

◆ getBorders()

◆ getClosesCoordinates()

◆ getElements()

◆ getEnveloppe()

◆ getGraphFamily()

◆ getOutsideBordersPair()

◆ getPeriod()

◆ getRelation()

◆ getStats()

◆ getStatsHeader()

◆ getTerritory()

◆ hash()

◆ height()

◆ ignit()

◆ insert()

◆ merge()

◆ midPosition()

◆ operator!=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ perimeter()

◆ setActionId()

◆ size()

◆ splitEvent()

◆ spread()

◆ width()

◆ willSplitEvent()

◆ within() [1/2]

◆ within() [2/2]

Friends And Related Function Documentation

◆ boost::serialization::access