nest::AbstractMask Class Reference

Abstract base class for masks with unspecified dimension. More...

#include <mask.h>

Inheritance diagram for nest::AbstractMask:

Public Member Functions
virtual	~AbstractMask ()
virtual bool	inside (const std::vector< double > &) const =0
virtual Dictionary	get_dict () const
virtual AbstractMask *	intersect_mask (const AbstractMask &other) const =0
	Create the intersection of this mask with another.
virtual AbstractMask *	union_mask (const AbstractMask &other) const =0
	Create the union of this mask with another.
virtual AbstractMask *	minus_mask (const AbstractMask &other) const =0
	Create the difference of this mask and another.

Detailed Description

Abstract base class for masks with unspecified dimension.

Constructor & Destructor Documentation

~AbstractMask()

virtual nest::AbstractMask::~AbstractMask ( )

inlinevirtual

Member Function Documentation

get_dict()

virtual Dictionary nest::AbstractMask::get_dict ( ) const

inlinevirtual

Returns

a dictionary with the definition for this mask.

Reimplemented in nest::AnchoredMask< D >, nest::GridMask< D >, nest::BoxMask< D >, nest::BallMask< D >, and nest::EllipseMask< D >.

inside()

virtual bool nest::AbstractMask::inside ( const std::vector< double > &  ) const

pure virtual

Returns

true if point is inside mask.

Implemented in nest::GridMask< D >, nest::Mask< D >, and nest::Mask< D >.

intersect_mask()

virtual AbstractMask * nest::AbstractMask::intersect_mask ( const AbstractMask &  other ) const

pure virtual

Create the intersection of this mask with another.

Masks must have the same dimension

Returns

a new dynamically allocated mask.

Implemented in nest::GridMask< D >, and nest::Mask< D >.

minus_mask()

virtual AbstractMask * nest::AbstractMask::minus_mask ( const AbstractMask &  other ) const

pure virtual

Create the difference of this mask and another.

Masks must have the same dimension.

Returns

a new dynamically allocated mask.

Implemented in nest::GridMask< D >, and nest::Mask< D >.

union_mask()

virtual AbstractMask * nest::AbstractMask::union_mask ( const AbstractMask &  other ) const

pure virtual

Create the union of this mask with another.

Masks must have the same dimension.

Returns

a new dynamically allocated mask.

Implemented in nest::GridMask< D >, and nest::Mask< D >.

---

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

• mask.h