Linear 2D grid base type. More...
#include <linear_grid.hpp>
Inheritance diagram for beluga::BaseLinearGrid2< Derived >:
Public Member Functions | |
| Eigen::Vector2d | coordinates_at (std::size_t index) const |
| Compute plane coordinates given a grid cell index. More... | |
| auto | data_at (std::size_t index) const |
| Gets cell data, if included. More... | |
| std::size_t | index_at (const Eigen::Vector2i &pi) const |
| Computes index for given grid cell coordinates. More... | |
| std::size_t | index_at (int xi, int yi) const |
| Computes index for given grid cell coordinates. More... | |
| auto | neighborhood4 (std::size_t index) const |
| Computes 4-connected neighborhood for cell. More... | |
 Public Member Functions inherited from beluga::BaseDenseGrid2< Derived > | |
| bool | contains (const Eigen::Vector2i &pi) const |
| Checks if a cell is included in the grid. More... | |
| bool | contains (int xi, int yi) const |
| Checks if a cell is included in the grid. More... | |
| auto | data_at (const Eigen::Vector2i &pi) const |
| Gets cell data, if included. More... | |
| auto | data_at (int xi, int yi) const |
| Gets cell data, if included. More... | |
| auto | data_near (const Eigen::Vector2d &p) const |
| Gets nearest cell data, if included. More... | |
| auto | data_near (double x, double y) const |
| Gets nearest cell data, if included. More... | |
| auto | neighborhood4 (const Eigen::Vector2i &pi) const |
| Computes 4-connected neighborhood for cell. More... | |
| auto | neighborhood4 (int xi, int yi) const |
| Computes 4-connected neighborhood for cell. More... | |
| Public Member Functions inherited from beluga::BaseRegularGrid< Derived, NDim > | |
| Eigen::Vector< int, NDim > | cell_near (const Eigen::Vector< double, NDim > &p) const |
| Compute nearest grid cell coordinates given plane coordinates. More... | |
| Eigen::Vector< double, NDim > | coordinates_at (const Eigen::Vector< int, NDim > &pi) const |
| Compute plane coordinates given grid cell coordinates. More... | |
| template<class Range > | |
| auto | coordinates_for (Range &&cells) const |
| Compute plane coordinates given a range of cell coordinates. More... | |
Detailed Description
template<typename Derived>
class beluga::BaseLinearGrid2< Derived >
Linear 2D grid base type.
When instantiated, it satisfies Beluga named requirements: LinearGrid2.
- Template Parameters
-
Derived Concrete linear grid type. It must define Derived::width(),Derived::height(),Derived::resolution(),Derived::data_at(std::size_t),Derived::index_at(int, int), andDerived::data()as described in Beluga named requirements: LinearGrid2.
Definition at line 64 of file linear_grid.hpp.
Member Function Documentation
◆ coordinates_at()
template<typename Derived >
|
inline |
Compute plane coordinates given a grid cell index.
- Parameters
-
index Grid cell index.
- Returns
- Plane coordinates of the cell centroid.
Definition at line 88 of file linear_grid.hpp.
◆ data_at()
template<typename Derived >
|
inline |
Gets cell data, if included.
- Parameters
-
index Grid cell index.
- Returns
- Cell data if included,
std::nulloptotherwise.
Definition at line 100 of file linear_grid.hpp.
◆ index_at() [1/2]
template<typename Derived >
|
inline |
Computes index for given grid cell coordinates.
- Parameters
-
pi Grid cell coordinates.
Definition at line 79 of file linear_grid.hpp.
◆ index_at() [2/2]
template<typename Derived >
|
inline |
Computes index for given grid cell coordinates.
Definition at line 71 of file linear_grid.hpp.
◆ neighborhood4()
template<typename Derived >
|
inline |
Computes 4-connected neighborhood for cell.
- Parameters
-
index Grid cell index.
- Returns
- range of neighbor cells' indices.
Definition at line 111 of file linear_grid.hpp.
The documentation for this class was generated from the following file: