Mask defining a box region. More...
#include <mask.h>
Public Member Functions | |
| BoxMask (const DictionaryDatum &) | |
| Parameters that should be in the dictionary: lower_left - Position of lower left corner (array of doubles) upper_right - Position of upper right corner (array of doubles) More... | |
| BoxMask (const Position< D > &lower_left, const Position< D > &upper_right) | |
| ~BoxMask () | |
| 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. More... | |
| DictionaryDatum | get_dict () const |
| Mask< D > * | clone () const |
| Clone method. More... | |
| template<> | |
| Name | get_name () |
| template<> | |
| Name | get_name () |
 Public Member Functions inherited from nest::Mask< D > | |
| ~Mask () | |
| bool | inside (const std::vector< double_t > &pt) const |
| 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... | |
Static Public Member Functions | |
| static Name | get_name () |
Protected Attributes | |
| Position< D > | lower_left_ |
| Position< D > | upper_right_ |
Detailed Description
template<int D>
class nest::BoxMask< D >
Mask defining a box region.
Constructor & Destructor Documentation
| nest::BoxMask< D >::BoxMask | ( | const DictionaryDatum & | d | ) |
Parameters that should be in the dictionary: lower_left - Position of lower left corner (array of doubles) upper_right - Position of upper right corner (array of doubles)
References nest::names::d, nest::names::lower_left, and nest::names::upper_right.
|
inline |
|
inline |
Member Function Documentation
|
virtual |
|
virtual |
The whole mask is inside (i.e., false everywhere outside) the bounding box.
- Returns
- bounding box
Implements nest::Mask< D >.
|
virtual |
- Returns
- a dictionary with the definition for this mask.
Reimplemented from nest::AbstractMask.
References nest::names::d, nest::names::lower_left, and nest::names::upper_right.
|
static |
- Returns
- the name of this mask type.
|
inline |
References nest::names::rectangular.
|
inline |
References nest::names::box.
|
virtual |
- Returns
- true if point is inside the box
Implements nest::Mask< D >.
|
virtual |
- Returns
- true if the whole given box is inside this box
Implements nest::Mask< D >.
References nest::Box< D >::lower_left, and nest::Box< D >::upper_right.
|
virtual |
- Returns
- true if the whole given box is outside this box
Reimplemented from nest::Mask< D >.
References nest::Box< D >::lower_left, and nest::Box< D >::upper_right.
Member Data Documentation
|
protected |
|
protected |
The documentation for this class was generated from the following files:
