mln::point< G, C > Struct Template Reference
Generic point class. More...
#include <point.hh>
Public Types | |
| enum | { dim = G::dim } |
| typedef Gpoint< void > | category |
| typedef C | coord |
| Coordinate associated type. | |
| typedef dpoint< G, C > | delta |
| Delta associated type. | |
| typedef dpoint< G, C > | dpsite |
| DPsite associated type. | |
| typedef E | exact_t |
| typedef G | grid |
| Grid associated type. | |
| typedef algebra::h_vec< G::dim, float > | h_vec |
| Algebra hexagonal vector (hvec) associated type. | |
| typedef point | psite |
| typedef point | site |
| typedef algebra::vec< G::dim, float > | vec |
| Algebra vector (vec) associated type. | |
Public Member Functions | |
| C & | last_coord () |
| Read-write access to the last coordinate. | |
| const C & | last_coord () const |
| Read-only access to the last coordinate. | |
| operator typename internal::vec_of_point< G, C >::ret () const | |
| point< G, C > & | operator+= (const delta &dp) |
Shifting by dp. | |
| point< G, C > & | operator-= (const delta &dp) |
Shifting by the inverse of dp. | |
| C & | operator[] (unsigned i) |
Read-write access to the i-th coordinate value. | |
| const C & | operator[] (unsigned i) const |
Read-only access to the i-th coordinate value. | |
| template<typename F> | |
| point (const Function_v2v< F > &f) | |
Constructor; coordinates are set by function f. | |
| template<typename C2> | |
| point (const algebra::vec< dim, C2 > &v) | |
| Constructor from an algebra vector. | |
| point () | |
| Constructor without argument. | |
| void | set_all (C c) |
Set all coordinates to the value c. | |
| h_vec | to_h_vec () const |
| Transform to point in homogene coordinate system. | |
| vec | to_vec () const |
| Explicit conversion towards mln::algebra::vec. | |
| point< G, C > & | operator= (const literal::one_t &) |
| point< G, C > & | operator= (const literal::zero_t &) |
| point< G, C > & | operator= (const literal::origin_t &) |
| point (const literal::one_t &) | |
| point (const literal::zero_t &) | |
| point (const literal::origin_t &) | |
| Constructors/assignments with literals. | |
| point (C sli, C row, C col) | |
| point (C row, C col) | |
| point (C ind) | |
Static Public Member Functions | |
| static const point< G, C > & | minus_infty () |
| Point with all coordinates set to the mininum value. | |
| static const point< G, C > & | plus_infty () |
| Point with all coordinates set to the maximum value. | |
Static Public Attributes | |
| static const point< G, C > | origin = all_to(0) |
| Origin point (all coordinates are 0). | |
Protected Attributes | |
| algebra::vec< G::dim, C > | coord_ |
Related Functions | |
| (Note that these are not member functions.) | |
| template<typename P, typename D> | |
| P | operator+ (const Gpoint< P > &p, const Gdpoint< D > &dp) |
Add a delta-point rhs to a grid point lhs. | |
| template<typename P, typename D> | |
| P & | operator+= (Gpoint< P > &p, const Gdpoint< D > &dp) |
Shift a point by a delta-point dp. | |
| template<typename L, typename R> | |
| L::delta | operator- (const Gpoint< L > &lhs, const Gpoint< R > &rhs) |
Difference between a couple of grid point lhs and rhs. | |
| template<typename P, typename D> | |
| P & | operator-= (Gpoint< P > &p, const Gdpoint< D > &dp) |
Shift a point by the negate of a delta-point dp. | |
| template<typename P, typename D> | |
| P | operator/ (const Gpoint< P > &p, const value::scalar_< D > &dp) |
Divise a point by a scalar s. | |
| template<typename P> | |
| std::ostream & | operator<< (std::ostream &ostr, const Gpoint< P > &p) |
Print a grid point p into the output stream ostr. | |
| template<typename L, typename R> | |
| bool | operator== (const Gpoint< L > &lhs, const Gpoint< R > &rhs) |
Equality comparison between a couple of grid point lhs and rhs. | |
Detailed Description
template<typename G, typename C>
struct mln::point< G, C >
Generic point class.
Parameters are n the dimension of the space and C the coordinate type in this space.
Definition at line 97 of file point.hh.
Member Typedef Documentation
typedef Gpoint<void> mln::Gpoint< E >::category [inherited] |
| typedef C mln::point< G, C >::coord |
| typedef dpoint<G,C> mln::point< G, C >::delta |
| typedef dpoint<G,C> mln::point< G, C >::dpsite |
typedef E mln::Object< E >::exact_t [inherited] |
| typedef G mln::point< G, C >::grid |
| typedef algebra::h_vec<G::dim, float> mln::point< G, C >::h_vec |
| typedef point mln::point< G, C >::psite |
| typedef point mln::point< G, C >::site |
| typedef algebra::vec<G::dim, float> mln::point< G, C >::vec |
Member Enumeration Documentation
| anonymous enum |
Constructor & Destructor Documentation
| mln::point< G, C >::point | ( | ) | [inline] |
| mln::point< G, C >::point | ( | const algebra::vec< dim, C2 > & | v | ) | [inline] |
Constructor from an algebra vector.
Definition at line 309 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| mln::point< G, C >::point | ( | C | ind | ) | [inline, explicit] |
Constructors with different numbers of arguments (coordinates) w.r.t. the dimension.
Definition at line 327 of file point.hh.
References mln::point< G, C >::coord_.
| mln::point< G, C >::point | ( | C | row, | |
| C | col | |||
| ) | [inline] |
| mln::point< G, C >::point | ( | C | sli, | |
| C | row, | |||
| C | col | |||
| ) | [inline] |
| mln::point< G, C >::point | ( | const literal::origin_t & | ) | [inline] |
Constructors/assignments with literals.
Definition at line 365 of file point.hh.
References mln::point< G, C >::coord_, and mln::algebra::vec< n, T >::set_all().
| mln::point< G, C >::point | ( | const literal::zero_t & | ) | [inline] |
| mln::point< G, C >::point | ( | const literal::one_t & | ) | [inline] |
| mln::point< G, C >::point | ( | const Function_v2v< F > & | f | ) | [inline] |
Constructor; coordinates are set by function f.
Definition at line 355 of file point.hh.
References mln::point< G, C >::coord_, mln::point< G, C >::dim, and mln::exact().
Member Function Documentation
| C & mln::point< G, C >::last_coord | ( | ) | [inline] |
Read-write access to the last coordinate.
Definition at line 292 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| const C & mln::point< G, C >::last_coord | ( | ) | const [inline] |
Read-only access to the last coordinate.
Definition at line 284 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
Referenced by mln::convert::impl::internal::from_image_to_site_set(), and mln::debug::put_word().
| const point< G, C > & mln::point< G, C >::minus_infty | ( | ) | [inline, static] |
| mln::point< G, C >::operator typename internal::vec_of_point< G, C >::ret | ( | ) | const [inline] |
| point< G, C > & mln::point< G, C >::operator+= | ( | const delta & | dp | ) | [inline] |
Shifting by dp.
Definition at line 428 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| point< G, C > & mln::point< G, C >::operator-= | ( | const delta & | dp | ) | [inline] |
Shifting by the inverse of dp.
Definition at line 438 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| point< G, C > & mln::point< G, C >::operator= | ( | const literal::one_t & | ) | [inline] |
| point< G, C > & mln::point< G, C >::operator= | ( | const literal::zero_t & | ) | [inline] |
| point< G, C > & mln::point< G, C >::operator= | ( | const literal::origin_t & | ) | [inline] |
Definition at line 373 of file point.hh.
References mln::point< G, C >::coord_, and mln::algebra::vec< n, T >::set_all().
| C & mln::point< G, C >::operator[] | ( | unsigned | i | ) | [inline] |
Read-write access to the i-th coordinate value.
- Parameters:
-
[in] i The coordinate index.
- Precondition:
i<dim
Definition at line 275 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| const C & mln::point< G, C >::operator[] | ( | unsigned | i | ) | const [inline] |
Read-only access to the i-th coordinate value.
- Parameters:
-
[in] i The coordinate index.
- Precondition:
i<dim
Definition at line 267 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| const point< G, C > & mln::point< G, C >::plus_infty | ( | ) | [inline, static] |
| void mln::point< G, C >::set_all | ( | C | c | ) | [inline] |
Set all coordinates to the value c.
Definition at line 417 of file point.hh.
References mln::point< G, C >::coord_, and mln::algebra::vec< n, T >::set_all().
| point< G, C >::h_vec mln::point< G, C >::to_h_vec | ( | ) | const [inline] |
Transform to point in homogene coordinate system.
Definition at line 476 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
| point< G, C >::vec mln::point< G, C >::to_vec | ( | ) | const [inline] |
Explicit conversion towards mln::algebra::vec.
Definition at line 455 of file point.hh.
References mln::point< G, C >::coord_, and mln::point< G, C >::dim.
Referenced by mln::registration::compute_distance_criteria(), mln::cut_(), mln::registration::draw_last_run(), mln::convert::over_load::from_to_(), mln::registration::get_mu_yk(), mln::io::magick::load(), mln::io::dicom::load(), mln::point< G, C >::operator typename internal::vec_of_point< G, C >::ret(), mln::registration::remove_too_far_sites(), mln::io::magick::save(), and mln::io::cloud::internal::save_data().
Friends And Related Function Documentation
| L::delta operator- | ( | const Gpoint< L > & | lhs, | |
| const Gpoint< R > & | rhs | |||
| ) | [related, inherited] |
Difference between a couple of grid point lhs and rhs.
- Warning:
- There is no type promotion in Milena so the client has to make sure that both points are defined with the same type of coordinates.
- Precondition:
- Both
lhsandrhshave to be defined on the same topology and with the same type of coordinates; otherwise this test does not compile.
- Postcondition:
- The result,
dp, is such aslhs==rhs+dp.
- Returns:
- A delta point (temporary object).
- See also:
- mln::Gdpoint
| P operator/ | ( | const Gpoint< P > & | p, | |
| const value::scalar_< D > & | dp | |||
| ) | [related, inherited] |
| std::ostream & operator<< | ( | std::ostream & | ostr, | |
| const Gpoint< P > & | p | |||
| ) | [related, inherited] |
| bool operator== | ( | const Gpoint< L > & | lhs, | |
| const Gpoint< R > & | rhs | |||
| ) | [related, inherited] |
Member Data Documentation
algebra::vec<G::dim, C> mln::point< G, C >::coord_ [protected] |
Definition at line 207 of file point.hh.
Referenced by mln::point< G, C >::last_coord(), mln::point< G, C >::operator+=(), mln::point< G, C >::operator-=(), mln::point< G, C >::operator=(), mln::point< G, C >::operator[](), mln::point< G, C >::point(), mln::point< G, C >::set_all(), mln::point< G, C >::to_h_vec(), and mln::point< G, C >::to_vec().
const point< G, C > mln::point< G, C >::origin = all_to(0) [inline, static] |
