Mask defining a circular or spherical region. More...
#include <mask.h>
Public Member Functions | |
| BallMask (Position< D > center, double_t radius) | |
| BallMask (const DictionaryDatum &) | |
| Creates a BallMask from a Dictionary which should contain the key "radius" with a double value and optionally the key "anchor" (the center position) with an array of doubles. More... | |
| ~BallMask () | |
| bool | inside (const Position< D > &p) const |
| bool | inside (const Box< D > &) 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 () |
| template<> | |
| bool | inside (const Box< 2 > &b) const |
| template<> | |
| bool | inside (const Box< 3 > &b) const |
 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 > | center_ |
| double_t | radius_ |
Detailed Description
template<int D>
class nest::BallMask< D >
Mask defining a circular or spherical region.
Constructor & Destructor Documentation
|
inline |
- Parameters
-
center Center of sphere radius Radius of sphere
| nest::BallMask< D >::BallMask | ( | const DictionaryDatum & | d | ) |
Creates a BallMask from a Dictionary which should contain the key "radius" with a double value and optionally the key "anchor" (the center position) with an array of doubles.
References nest::names::anchor, nest::names::d, and nest::names::radius.
|
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 >.
References nest::Box< D >::lower_left, and nest::Box< D >::upper_right.
|
virtual |
- Returns
- a dictionary with the definition for this mask.
Reimplemented from nest::AbstractMask.
References nest::names::anchor, nest::names::d, and nest::names::radius.
|
static |
- Returns
- the name of this mask type.
|
inline |
References nest::names::circular.
|
inline |
References nest::names::spherical.
| bool nest::BallMask< 2 >::inside | ( | const Box< 2 > & | b | ) | const |
References nest::Box< D >::lower_left, nest::names::p, and nest::Box< D >::upper_right.
| bool nest::BallMask< 3 >::inside | ( | const Box< 3 > & | b | ) | const |
References nest::Box< D >::lower_left, nest::names::p, and nest::Box< D >::upper_right.
|
virtual |
- Returns
- true if point is inside the circle
Implements nest::Mask< D >.
|
virtual |
- Returns
- true if the whole box is inside the circle
Implements nest::Mask< D >.
|
virtual |
- Returns
- true if the whole box is outside the circle
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:
