$extrastylesheet
#include <mln/core/alias/box3d.hh>
Public Member Functions | |
box3d () | |
box3d (const point3d &pmin, const point3d &pmax) | |
box3d (typename mln::point3d::coord nslis, typename mln::point3d::coord nrows, typename mln::point3d::coord ncols) | |
const box< mln::point3d > & | bbox () const |
void | crop_wrt (const box< mln::point3d > &b) |
void | enlarge (unsigned b) |
void | enlarge (unsigned dim, unsigned b) |
bool | has (const mln::point3d &p) const |
bool | is_empty () const |
bool | is_valid () const |
unsigned | len (unsigned i) const |
std::size_t | memory_size () const |
void | merge (const box< mln::point3d > &b) |
unsigned | nsites () const |
mln::point3d | pcenter () const |
mln::point3d | pmax () const |
mln::point3d & | pmax () |
mln::point3d | pmin () const |
mln::point3d & | pmin () |
box< mln::point3d > | to_larger (unsigned b) const |
Protected Attributes | |
mln::point3d | pmax_ |
mln::point3d | pmin_ |
Public Types | |
enum | |
typedef box_bkd_piter_ < mln::point3d > | bkd_piter |
typedef Site_Set< void > | category |
typedef mln::point3d | element |
typedef box< mln::point3d > | exact_t |
typedef box_fwd_piter_ < mln::point3d > | fwd_piter |
typedef fwd_piter | piter |
typedef mln::point3d | psite |
typedef const box< mln::point3d > & | q_box |
typedef mln::point3d | site |
A box defined on the 3D square grid with integer coordinates.
This class is a site set of mln::point3d. It represents a rectangle of mln::point3d which is usually used as domain for a mln::image3d.
mln::box3d is a typedef of box<mln::point3d>.
Iteration over the mln::point3d of a mln::box3d relies on p-iterators and it can be performed using the following code:
Common sites can be retrieved through pmin(), pmax() and pcenter().
pmin X------------. /| /| .-|---------./ | | | X | | | .---------|--.--------> |/ pcenter | / | |/ ------------X / pmax / \/
mln::box3d::box3d | ( | ) |
Constructor without argument.
Constructor of a box going from pmin
to pmax
.
mln::box3d::box3d | ( | typename mln::point3d::coord | nslis, |
typename mln::point3d::coord | nrows, | ||
typename mln::point3d::coord | ncols | ||
) |
Construct a box3d with nrows
rows and ncols
columns.
The pmin() site is set to mln::point3d(0,0,0).
|
inherited |
Give the bounding box of this site set.
Return the bounding box of this site set, so that is itself. This method is declared by the mln::Site_Set concept.
|
inherited |
Crop this bbox in order to fit in the reference box b
.
|
inherited |
Enlarge the box with a border b
.
|
inherited |
Enlarge the box with a border b
for dimension dim
.
|
inherited |
Test if p
belongs to the box.
[in] | p | A point site. |
|
inherited |
Test if this box is empty.
|
inherited |
Test that the box owns valid data, i.e., is initialized and with pmin being 'less-than' pmax.
|
inherited |
Give the length of the i-th
side of the box.
|
inherited |
Return the size of this site set in memory.
|
inherited |
Merge inplace with another box.
|
inherited |
Give the number of sites of this box.
Return the number of sites of this box. This method is declared by the mln::Site_Set concept.
|
inherited |
Return the approximated central site of this box.
|
inherited |
Maximum point.
|
inherited |
Reference to the maximum point.
|
inherited |
Minimum point.
|
inherited |
Reference to the minimum point.
|
inherited |
Give a larger box.
|
protectedinherited |
Definition at line 165 of file core/site_set/box.hh.
|
protectedinherited |
Definition at line 165 of file core/site_set/box.hh.
|
inherited |
Backward Site_Iterator associated type.
Definition at line 105 of file core/site_set/box.hh.
|
inherited |
Definition at line 74 of file core/concept/site_set.hh.
|
inherited |
Element associated type.
Definition at line 90 of file core/site_set/box.hh.
|
inherited |
|
inherited |
Forward Site_Iterator associated type.
Definition at line 99 of file core/site_set/box.hh.
|
inherited |
Site_Iterator associated type.
Definition at line 102 of file core/site_set/box.hh.
|
inherited |
Psite associated type.
Definition at line 93 of file core/site_set/box.hh.
|
inherited |
Definition at line 64 of file core/concept/box.hh.
|
inherited |
Site associated type.
Definition at line 96 of file core/site_set/box.hh.
|
inherited |
Dimension.
Definition at line 87 of file core/site_set/box.hh.