Abstract base class for masks with given dimension. More...
#include <mask.h>
Public Member Functions | |
| ~Mask () | |
| virtual bool | inside (const Position< D > &) const =0 |
| bool | inside (const std::vector< double_t > &pt) const |
| virtual bool | inside (const Box< D > &) const =0 |
| virtual bool | outside (const Box< D > &b) const |
| virtual Box< D > | get_bbox () const =0 |
| The whole mask is inside (i.e., false everywhere outside) the bounding box. More... | |
| virtual Mask * | clone () const =0 |
| Clone method. More... | |
| AbstractMask * | intersect_mask (const AbstractMask &other) const |
| Create the intersection of this mask with another. More... | |
| AbstractMask * | union_mask (const AbstractMask &other) const |
| Create the union of this mask with another. More... | |
| AbstractMask * | minus_mask (const AbstractMask &other) const |
| Create the difference of this mask and another. More... | |
 Public Member Functions inherited from nest::AbstractMask | |
| virtual | ~AbstractMask () |
| Virtual destructor. More... | |
| virtual DictionaryDatum | get_dict () const |
Detailed Description
template<int D>
class nest::Mask< D >
Abstract base class for masks with given dimension.
Constructor & Destructor Documentation
|
inline |
Member Function Documentation
|
pure virtual |
Clone method.
- Returns
- dynamically allocated copy of mask object
Implemented in nest::AnchoredMask< D >, nest::ConverseMask< D >, nest::DifferenceMask< D >, nest::UnionMask< D >, nest::IntersectionMask< D >, nest::BallMask< D >, nest::BoxMask< D >, and nest::AllMask< D >.
|
pure virtual |
The whole mask is inside (i.e., false everywhere outside) the bounding box.
- Returns
- bounding box
Implemented in nest::AnchoredMask< D >, nest::ConverseMask< D >, nest::DifferenceMask< D >, nest::UnionMask< D >, nest::IntersectionMask< D >, nest::BallMask< D >, nest::BoxMask< D >, and nest::AllMask< D >.
Referenced by nest::MaskedLayer< D >::check_mask_(), and nest::GridLayer< D >::masked_iterator::masked_iterator().
|
pure virtual |
- Returns
- true if point is inside mask.
Implemented in nest::AnchoredMask< D >, nest::ConverseMask< D >, nest::DifferenceMask< D >, nest::UnionMask< D >, nest::IntersectionMask< D >, nest::BallMask< D >, nest::BoxMask< D >, and nest::AllMask< D >.
|
virtual |
- Returns
- true if point is inside mask.
Implements nest::AbstractMask.
|
pure 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.
Implemented in nest::AnchoredMask< D >, nest::ConverseMask< D >, nest::DifferenceMask< D >, nest::UnionMask< D >, nest::IntersectionMask< D >, nest::BallMask< D >, nest::BoxMask< D >, and nest::AllMask< D >.
|
virtual |
Create the intersection of this mask with another.
Masks must have the same dimension
- Returns
- a new dynamically allocated mask.
Implements nest::AbstractMask.
References nest::names::other.
|
virtual |
Create the difference of this mask and another.
Masks must have the same dimension.
- Returns
- a new dynamically allocated mask.
Implements nest::AbstractMask.
References nest::names::other.
|
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 in nest::AnchoredMask< D >, nest::ConverseMask< D >, nest::DifferenceMask< D >, nest::UnionMask< D >, nest::IntersectionMask< D >, nest::BallMask< D >, nest::BoxMask< D >, and nest::AllMask< D >.
References nest::Box< D >::lower_left, and nest::Box< D >::upper_right.
|
virtual |
Create the union of this mask with another.
Masks must have the same dimension.
- Returns
- a new dynamically allocated mask.
Implements nest::AbstractMask.
References nest::names::other.
The documentation for this class was generated from the following files:
