mln::pw::internal::image_base< F, S, E > Struct Template Reference
A base class for point-wise images. More...
#include <image_base.hh>
Public Types | |
| typedef S::bkd_piter | bkd_piter |
| Backward Site_Iterator associated type. | |
| typedef Image< void > | category |
| typedef S | domain_t |
| Site_Set associated type. | |
| typedef E | exact_t |
| typedef F | function_t |
| Function associated type. | |
| typedef S::fwd_piter | fwd_piter |
| Forward Site_Iterator associated type. | |
| typedef F::mutable_result | mutable_result |
| typedef fwd_piter | piter |
| Site_Iterator associated type; default definition is fwd_piter. | |
| typedef S::psite | psite |
| Point_Site associated type. | |
| typedef F::result | rvalue |
| Return type of read-only access. | |
| typedef S::site | site |
| Site associated type. | |
| typedef mln::value::set < F::result > | t_eligible_values_set |
| Eligible-value-set associated type. | |
| typedef mln::value::set < typename mln::value::super_value < F::result >::ret > | t_values_space |
| Value space associated type. | |
| typedef F::result | value |
| Value associated type. | |
Public Member Functions | |
| void | destroy () |
| Detach data from an image (free it if nobody else hold it). | |
| const S & | domain () const |
| Give the definition domain. | |
| F | function () const |
| Return the function which computes a site value. | |
| bool | has (const psite &p) const |
Test if p belongs to the image domain. | |
| const util::tracked_ptr < internal::data< E > > & | hook_data_ () const |
| Hook to the image data. | |
| const void * | id_ () const |
| Give an identifier of this image. | |
| template<typename P> | |
| unsigned | index_of_point (const P &p) const |
Give the offset of the site p. | |
| void | init_ (const Function_v2v< F > &f, const Site_Set< S > &ps) |
| Initialize an empty image. | |
| bool | is_valid () const |
| Test if this image has been initialized; default impl. | |
| typedef | mlc_if (is_mutable, mutable_result, typename F::result) lvalue |
| Return type of read-write access. | |
| typedef | mlc_not_equal (mutable_result, void) is_mutable |
| std::size_t | nsites () const |
| Give the number of sites of the image domain. | |
| lvalue | operator() (const typename S::psite &p) |
| Read-write access returns either a temporary value (copy) or a reference in the case of a mutable function (container). | |
| rvalue | operator() (const typename S::psite &p) const |
Read-only access of pixel value at point site p. | |
| const t_eligible_values_set & | values_eligible () const |
| const t_values_space & | values_space () const |
| Return the value space of the image. | |
Protected Member Functions | |
| image_base (const Function_v2v< F > &f, const Site_Set< S > &ps) | |
| image_base () | |
| Constructor without argument. | |
Protected Attributes | |
| util::tracked_ptr < internal::data< E > > | data_ |
Detailed Description
template<typename F, typename S, typename E>
struct mln::pw::internal::image_base< F, S, E >
A base class for point-wise images.
Parameter F is the image value type. Parameter S is the image site set type.
Definition at line 114 of file pw/internal/image_base.hh.
Member Typedef Documentation
typedef S ::bkd_piter mln::internal::image_base< F::result , S , E >::bkd_piter [inherited] |
typedef Image<void> mln::Image< E >::category [inherited] |
typedef S mln::internal::image_base< F::result , S , E >::domain_t [inherited] |
typedef E mln::Object< E >::exact_t [inherited] |
| typedef F mln::pw::internal::image_base< F, S, E >::function_t |
typedef S ::fwd_piter mln::internal::image_base< F::result , S , E >::fwd_piter [inherited] |
| typedef F::mutable_result mln::pw::internal::image_base< F, S, E >::mutable_result |
Definition at line 117 of file pw/internal/image_base.hh.
typedef fwd_piter mln::internal::image_base< F::result , S , E >::piter [inherited] |
Site_Iterator associated type; default definition is fwd_piter.
Definition at line 123 of file core/internal/image_base.hh.
typedef S ::psite mln::internal::image_base< F::result , S , E >::psite [inherited] |
Point_Site associated type.
Reimplemented in mln::edge_image< P, V, G >, and mln::vertex_image< P, V, G >.
Definition at line 108 of file core/internal/image_base.hh.
| typedef F ::result mln::pw::internal::image_base< F, S, E >::rvalue |
Return type of read-only access.
Reimplemented in mln::edge_image< P, V, G >, and mln::vertex_image< P, V, G >.
Definition at line 128 of file pw/internal/image_base.hh.
typedef S ::site mln::internal::image_base< F::result , S , E >::site [inherited] |
typedef mln::value::set<F::result > mln::internal::image_base< F::result , S , E >::t_eligible_values_set [inherited] |
typedef mln::value::set< typename mln::value::super_value<F::result >::ret > mln::internal::image_base< F::result , S , E >::t_values_space [inherited] |
| typedef F ::result mln::pw::internal::image_base< F, S, E >::value |
Value associated type.
Reimplemented from mln::internal::image_base< F::result, S, E >.
Definition at line 125 of file pw/internal/image_base.hh.
Constructor & Destructor Documentation
| mln::pw::internal::image_base< F, S, E >::image_base | ( | ) | [inline, protected] |
Constructor without argument.
Reimplemented from mln::internal::image_base< F::result, S, E >.
Definition at line 193 of file pw/internal/image_base.hh.
| mln::pw::internal::image_base< F, S, E >::image_base | ( | const Function_v2v< F > & | f, | |
| const Site_Set< S > & | ps | |||
| ) | [inline, protected] |
Definition at line 199 of file pw/internal/image_base.hh.
References mln::internal::image_base< F::result, S, E >::data_, and mln::exact().
Member Function Documentation
| void mln::internal::image_base< F::result , S , E >::destroy | ( | ) | [inherited] |
Detach data from an image (free it if nobody else hold it).
| const S & mln::pw::internal::image_base< F, S, E >::domain | ( | ) | const [inline] |
Give the definition domain.
Definition at line 215 of file pw/internal/image_base.hh.
References mln::internal::image_base< F::result, S, E >::data_.
Referenced by mln::make::edge_image().
| F mln::pw::internal::image_base< F, S, E >::function | ( | ) | const [inline] |
Return the function which computes a site value.
Definition at line 223 of file pw/internal/image_base.hh.
References mln::internal::image_base< F::result, S, E >::data_.
Referenced by mln::init_().
| bool mln::internal::image_base< F::result , S , E >::has | ( | const psite & | p | ) | const [inherited] |
Test if p belongs to the image domain.
| const util::tracked_ptr< internal::data<E > >& mln::internal::image_base< F::result , S , E >::hook_data_ | ( | ) | const [inherited] |
Hook to the image data.
| const void* mln::internal::image_base< F::result , S , E >::id_ | ( | ) | const [inherited] |
Give an identifier of this image.
When several image variables designate the same image, they share the same identifier.
| unsigned mln::internal::check::image_fastest_< E, B >::index_of_point | ( | const P & | p | ) | const [inline, inherited] |
Give the offset of the site p.
- Parameters:
-
[in] p A site.
- Warning:
- This method is final.
- Precondition:
- The image has to be initialized and to own the point
p.
- Postcondition:
- p == point_at_index(result)
Definition at line 133 of file internal/check/image_fastest.hh.
| void mln::pw::internal::image_base< F, S, E >::init_ | ( | const Function_v2v< F > & | f, | |
| const Site_Set< S > & | ps | |||
| ) | [inline] |
Initialize an empty image.
Definition at line 207 of file pw/internal/image_base.hh.
References mln::internal::image_base< F::result, S, E >::data_, and mln::exact().
Referenced by mln::init_().
| bool mln::internal::image_base< F::result , S , E >::is_valid | ( | ) | const [inherited] |
| typedef mln::pw::internal::image_base< F, S, E >::mlc_if | ( | is_mutable | , | |
| mutable_result | , | |||
| typename F::result | ||||
| ) |
Return type of read-write access.
| typedef mln::pw::internal::image_base< F, S, E >::mlc_not_equal | ( | mutable_result | , | |
| void | ||||
| ) |
| std::size_t mln::internal::image_base< F::result , S , E >::nsites | ( | ) | const [inherited] |
Give the number of sites of the image domain.
| image_base< F, S, E >::lvalue mln::pw::internal::image_base< F, S, E >::operator() | ( | const typename S::psite & | p | ) | [inline] |
Read-write access returns either a temporary value (copy) or a reference in the case of a mutable function (container).
Definition at line 241 of file pw/internal/image_base.hh.
References mln::internal::image_base< F::result, S, E >::data_.
| image_base< F, S, E >::rvalue mln::pw::internal::image_base< F, S, E >::operator() | ( | const typename S::psite & | p | ) | const [inline] |
Read-only access of pixel value at point site p.
Definition at line 232 of file pw/internal/image_base.hh.
References mln::internal::image_base< F::result, S, E >::data_.
| const t_eligible_values_set& mln::internal::image_base< F::result , S , E >::values_eligible | ( | ) | const [inherited] |
| const t_values_space& mln::internal::image_base< F::result , S , E >::values_space | ( | ) | const [inherited] |
Return the value space of the image.
Member Data Documentation
util::tracked_ptr< internal::data<E > > mln::internal::image_base< F::result , S , E >::data_ [protected, inherited] |
Definition at line 163 of file core/internal/image_base.hh.
Referenced by mln::pw::internal::image_base< F, S, E >::domain(), mln::pw::internal::image_base< F, S, E >::function(), mln::pw::image< F, S >::image(), mln::pw::internal::image_base< F, S, E >::image_base(), mln::pw::internal::image_base< F, S, E >::init_(), mln::vertex_image< P, V, G >::operator()(), mln::pw::internal::image_base< F, S, E >::operator()(), and mln::edge_image< P, V, G >::operator()().
