Generic box class: site set containing points of a regular grid. More...

#include <box.hh>

Inheritance diagram for mln::box:

Public Types
enum	{ dim = P::dim }
	Dimension. More...
typedef box_bkd_piter_< P >	bkd_piter
	Backward Site_Iterator associated type.
typedef Site_Set< void >	category
typedef P	element
	Element associated type.
typedef box< P >	exact_t
typedef box_fwd_piter_< P >	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef P	psite
	Psite associated type.
typedef const box< P > &	q_box
typedef P	site
	Site associated type.
Public Member Functions
const box< P > &	bbox () const
	Give the bounding box of this site set.
	box ()
	Constructor without argument.
	box (const site &pmin, const site &pmax)
	Constructor of a box going from `pmin` to `pmax`.
P	center () const
	Return the approximated central site of this box.
void	crop_wrt (const box< P > &b)
	Crop this bbox in order to fit in the reference box `b`.
void	enlarge (unsigned dim, unsigned b)
	Enlarge the box with a border `b` for dimension `dim`.
void	enlarge (unsigned b)
	Enlarge the box with a border `b`.
bool	has (const P &p) const
	Test if `p` belongs to the box.
bool	is_empty () const
	Test if this box is empty.
bool	is_valid () const
	Test that the box owns valid data, i.e., is initialized and with pmin being 'less-than' pmax.
unsigned	len (unsigned i) const
	Give the length of the `i-th` side of the box.
std::size_t	memory_size () const
	Return the size of this site set in memory.
unsigned	nsites () const
	Give the number of sites of this box.
P	pmax () const
	Maximum point.
P &	pmax ()
	Reference to the maximum point.
P	pmin () const
	Minimum point.
P &	pmin ()
	Reference to the minimum point.
box< P >	to_larger (unsigned b) const
	Give a larger box.


	box (typename P::coord ninds)
	box (typename P::coord nrows, typename P::coord ncols)
	box (typename P::coord nslis, typename P::coord nrows, typename P::coord ncols)
Protected Attributes
P	pmax_
P	pmin_
Related Functions
(Note that these are not member functions.)
template<typename P >
std::ostream &	operator<< (std::ostream &ostr, const box< P > &b)
	Print a generic box `b` into the output stream `ostr`.

Detailed Description

template<typename P>
struct mln::box

Generic box class: site set containing points of a regular grid.

Parameter P is the corresponding type of point.

Member Typedef Documentation

template<typename P>

typedef box_bkd_piter_ mln::box::bkd_piter

Backward Site_Iterator associated type.

typedef Site_Set<void> mln::Site_Set< box >::category [inherited]

Reimplemented from mln::Object< box >.

template<typename P>

typedef P mln::box::element

Element associated type.

typedef box mln::Object< box >::exact_t [inherited]

template<typename P>

typedef box_fwd_piter_ mln::box::fwd_piter

Forward Site_Iterator associated type.

template<typename P>

typedef fwd_piter mln::box::piter

Site_Iterator associated type.

template<typename P>

typedef P mln::box::psite

Psite associated type.

typedef const box & mln::Box< box >::q_box [inherited]

template<typename P>

typedef P mln::box::site

Site associated type.

Member Enumeration Documentation

template<typename P>

anonymous enum

Dimension.

Enumerator:

dim

Constructor & Destructor Documentation

template<typename P >

mln::box::box ( ) [inline]

Constructor without argument.

template<typename P >

mln::box< P >::box	(	const site &	pmin,
		const site &	pmax
	)			`[inline]`

Constructor of a box going from pmin to pmax.

References mln::box::is_valid().

template<typename P>

mln::box::box ( typename P::coord ninds ) [inline, explicit]

Constructors with different numbers of arguments (sizes) w.r.t. the dimension.

References mln::literal::origin, mln::box::pmax_, and mln::box::pmin_.

template<typename P>

mln::box< P >::box	(	typename P::coord	nrows,
		typename P::coord	ncols
	)			`[inline]`

References mln::box::is_valid(), mln::literal::origin, mln::box::pmax_, and mln::box::pmin_.

template<typename P>

mln::box< P >::box	(	typename P::coord	nslis,
		typename P::coord	nrows,
		typename P::coord	ncols
	)			`[inline]`

References mln::box::is_valid(), mln::literal::origin, mln::box::pmax_, and mln::box::pmin_.

Member Function Documentation

const box & mln::Box< box >::bbox ( ) const [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.

Warning:: This method is final for all box classes.

template<typename P >

P mln::box::center ( ) const [inline]

Return the approximated central site of this box.

References mln::box::is_valid(), mln::box::pmax_, and mln::box::pmin_.

Referenced by mln::geom::rotate().

template<typename P>

void mln::box::crop_wrt ( const box & b ) [inline]

Crop this bbox in order to fit in the reference box b.

References mln::box::pmax(), mln::box::pmax_, mln::box::pmin(), and mln::box::pmin_.

Referenced by mln::make_debug_graph_image().

template<typename P >

void mln::box::enlarge ( unsigned b ) [inline]

Enlarge the box with a border b.

References mln::box::is_valid(), mln::box::pmax_, and mln::box::pmin_.

Referenced by mln::registration::closest_point_with_map::closest_point_with_map(), and mln::registration::icp().

template<typename P >

void mln::box< P >::enlarge	(	unsigned	dim,
		unsigned	b
	)			`[inline]`

Enlarge the box with a border b for dimension dim.

References mln::box::is_valid(), mln::box::pmax_, and mln::box::pmin_.

template<typename P>

bool mln::box::has ( const P & p ) const [inline]

Test if p belongs to the box.

Parameters:

[in] p A point site.

References mln::box::is_valid(), mln::box::pmax_, and mln::box::pmin_.

Referenced by mln::morpho::line_gradient(), my_box2d::operator()(), f_box3d_t::operator()(), f_box2d_t::operator()(), and f_box1d_t::operator()().

bool mln::Box< box >::is_empty ( ) const [inherited]

Test if this box is empty.

template<typename P >

bool mln::box::is_valid ( ) const [inline]

Test that the box owns valid data, i.e., is initialized and with pmin being 'less-than' pmax.

References mln::util::ord_weak(), mln::box::pmax_, and mln::box::pmin_.

Referenced by mln::box::box(), mln::box::center(), mln::registration::closest_point_with_map::closest_point_with_map(), mln::transform::distance_and_closest_point_geodesic(), mln::box::enlarge(), mln::box::has(), mln::p_line2d::is_valid(), mln::box::pmax(), mln::box::pmin(), mln::accu::shape::bbox::take(), and mln::box::to_larger().

unsigned mln::Box< box >::len ( unsigned i ) const [inherited]

Give the length of the i-th side of the box.

Precondition:: i < site::dim

Warning:: This method is final for all box classes.

Referenced by mln::fun::p2p::internal::do_fold_helper< 3, fold< P, dir_0, dir_1, dir_2 > >::run(), mln::fun::p2p::internal::do_fold_helper< 2, fold< P, dir_0, dir_1,-1 > >::run(), and mln::fun::p2p::internal::do_fold_helper< 1, fold< P,-1,-1,-1 > >::run().

template<typename P >

std::size_t mln::box::memory_size ( ) const [inline]

Return the size of this site set in memory.

unsigned mln::Box< box >::nsites ( ) const [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.

Warning:: This method is final for all box classes.

template<typename P >

P mln::box::pmax ( ) const [inline]

Maximum point.

References mln::box::is_valid(), and mln::box::pmax_.

Referenced by mln::p_line2d::compute_(), mln::box::crop_wrt(), mln::world::inter_pixel::display_edge(), mln::hexa_fwd_piter_< S >::hexa_fwd_piter_(), mln::make::image3d(), mln::hexa::init_(), mln::larger_than(), mln::geom::max_col(), mln::geom::max_row(), mln::world::binary_2d::reduce(), and mln::accu::shape::bbox::take().

template<typename P >

P & mln::box::pmax ( ) [inline]

Reference to the maximum point.

References mln::box::pmax_.

template<typename P >

P & mln::box::pmin ( ) [inline]

Reference to the minimum point.

References mln::box::pmin_.

template<typename P >

P mln::box::pmin ( ) const [inline]

Minimum point.

References mln::box::is_valid(), and mln::box::pmin_.

Referenced by mln::p_line2d::compute_(), mln::box::crop_wrt(), mln::world::inter_pixel::display_edge(), mln::hexa_fwd_piter_< S >::hexa_fwd_piter_(), mln::make::image3d(), mln::hexa::init_(), mln::larger_than(), mln::geom::min_col(), mln::geom::min_row(), mln::world::binary_2d::reduce(), and mln::accu::shape::bbox::take().

template<typename P >

box mln::box::to_larger ( unsigned b ) const [inline]

Give a larger box.

References mln::box::is_valid(), mln::box::pmax_, and mln::box::pmin_.

Friends And Related Function Documentation

template<typename P >

std::ostream & operator<<	(	std::ostream &	ostr,
		const box< P > &	b
	)			`[related]`

Print a generic box b into the output stream ostr.

Parameters:

`[in,out]`	ostr	An output stream.
`[in]`	b	A generic box.

Returns:: The modified output stream ostr.

Member Data Documentation

template<typename P>

P mln::box::pmax_ [protected]

Referenced by mln::box::box(), mln::box::center(), mln::box::crop_wrt(), mln::box::enlarge(), mln::box::has(), mln::box::is_valid(), mln::box::pmax(), and mln::box::to_larger().

template<typename P>

P mln::box::pmin_ [protected]

Referenced by mln::box::box(), mln::box::center(), mln::box::crop_wrt(), mln::box::enlarge(), mln::box::has(), mln::box::is_valid(), mln::box::pmin(), and mln::box::to_larger().

mln::box< P > Struct Template Reference
[Basic types]

Public Types

Public Member Functions

Protected Attributes

Related Functions

Detailed Description

template<typename P>
struct mln::box< P >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

mln::box< P > Struct Template Reference [Basic types]

Public Types

Public Member Functions

Protected Attributes

Related Functions

Detailed Description

template<typename P> struct mln::box< P >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

mln::box< P > Struct Template Reference
[Basic types]

template<typename P>
struct mln::box< P >