nest::AnchoredMask< D > Class Template Reference

Mask shifted by an anchor. More...

#include <mask.h>

Inheritance diagram for nest::AnchoredMask< D >:

Collaboration diagram for nest::AnchoredMask< D >:

Public Member Functions
	AnchoredMask (const Mask< D > &m, Position< D > anchor)
	Construct the converse of the two given mask.
	AnchoredMask (const AnchoredMask &m)
	~AnchoredMask ()
bool	inside (const Position< D > &p) const
bool	inside (const Box< D > &b) const
bool	outside (const Box< D > &b) const
Box< D >	get_bbox () const
	The whole mask is inside (i.e., false everywhere outside) the bounding box.
Dictionary	get_dict () const
Mask< D > *	clone () const
	Clone method.
Public Member Functions inherited from nest::Mask< D >
	~Mask () override
bool	inside (const std::vector< double > &pt) const override
AbstractMask *	intersect_mask (const AbstractMask &other) const override
	Create the intersection of this mask with another.
AbstractMask *	union_mask (const AbstractMask &other) const override
	Create the union of this mask with another.
AbstractMask *	minus_mask (const AbstractMask &other) const override
	Create the difference of this mask and another.
virtual bool	inside (const std::vector< double > &) const=0
Public Member Functions inherited from nest::AbstractMask
virtual	~AbstractMask ()

Protected Attributes
Mask< D > *	m_
Position< D >	anchor_

Detailed Description

template<int D>
class nest::AnchoredMask< D >

Mask shifted by an anchor.

Constructor & Destructor Documentation

AnchoredMask() [1/2]

template<int D>

nest::AnchoredMask< D >::AnchoredMask ( const Mask< D > &  m, Position< D >  anchor  )

inline

Construct the converse of the two given mask.

A copy is made of the supplied Mask object.

AnchoredMask() [2/2]

template<int D>

nest::AnchoredMask< D >::AnchoredMask ( const AnchoredMask< D > &  m )

inline

~AnchoredMask()

template<int D>

nest::AnchoredMask< D >::~AnchoredMask ( )

inline

References nest::AnchoredMask< D >::m_.

Member Function Documentation

clone()

template<int D>

Mask< D > * nest::AnchoredMask< D >::clone ( ) const

virtual

Clone method.

Returns

dynamically allocated copy of mask object

Implements nest::Mask< D >.

get_bbox()

template<int D>

Box< D > nest::AnchoredMask< D >::get_bbox ( ) const

virtual

The whole mask is inside (i.e., false everywhere outside) the bounding box.

Returns

bounding box

Implements nest::Mask< D >.

References nest::Box< D >::lower_left, and nest::Box< D >::upper_right.

get_dict()

template<int D>

Dictionary nest::AnchoredMask< D >::get_dict ( ) const

virtual

Returns

a dictionary with the definition for this mask.

Reimplemented from nest::AbstractMask.

References nest::names::anchor().

Here is the call graph for this function:

inside() [1/2]

template<int D>

bool nest::AnchoredMask< D >::inside ( const Box< D > &  ) const

virtual

Returns

true if the whole box is inside the mask.

Note

a return value of false is not a guarantee that the whole box is not inside the mask.

Implements nest::Mask< D >.

inside() [2/2]

template<int D>

bool nest::AnchoredMask< D >::inside ( const Position< D > &  ) const

virtual

Returns

true if point is inside mask.

Implements nest::Mask< D >.

outside()

template<int D>

bool nest::AnchoredMask< D >::outside ( const Box< D > &  b ) const

virtual

Returns

true if the whole box is outside the mask.

Note

a return value of false is not a guarantee that the whole box is not outside the mask.

Reimplemented from nest::Mask< D >.

Member Data Documentation

anchor_

template<int D>

Position< D > nest::AnchoredMask< D >::anchor_

protected

m_

template<int D>

Mask< D >* nest::AnchoredMask< D >::m_

protected

Referenced by nest::AnchoredMask< D >::~AnchoredMask().

---

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

• mask.h
• mask_impl.h