Documentation class for the concept of images that have the speed property set to "fastest". More...
#include <image_fastest.hh>
Public Types | |
typedef void | bkd_piter |
Backward point iterator associated type. | |
typedef void | coord |
Coordinate associated type. | |
typedef void | dpoint |
Dpsite associated type. | |
typedef void | fwd_piter |
Forward point iterator associated type. | |
typedef void | lvalue |
Type returned by the read-write pixel value operator. | |
typedef void | point |
Site associated type. | |
typedef void | pset |
Point set associated type. | |
typedef void | psite |
Point_Site associated type. | |
typedef void | rvalue |
Type returned by the read pixel value operator. | |
typedef void | skeleton |
Associate type that describes how this type of image is constructed. | |
typedef void | value |
Value associated type. | |
typedef void | vset |
Value set associated type. | |
Public Member Functions | |
const box< point > & | bbox () const |
Give a bounding box of the image domain. | |
unsigned | border () |
Give the border thickness. | |
const value * | buffer () const |
Give a hook to the value buffer. | |
int | delta_index (const dpoint &dp) |
Give the offset corresponding to the delta-point dp . | |
const pset & | domain () const |
Give the definition domain of the image. | |
bool | has (const psite &p) const |
Test if the image owns the point site p . | |
bool | has (const psite &p) const |
Test if p belongs to the image domain. | |
bool | is_valid () const |
Test if the image have been initialized. | |
unsigned | nelements () const |
Give the number of pixels of the image including those of the virtual border. | |
unsigned | nsites () const |
Give the number of points of the image domain. | |
lvalue | operator() (const psite &p) |
Read-write access to the image value located at p . | |
rvalue | operator() (const psite &p) const |
Read-only access to the image value located at p . | |
rvalue | operator[] (unsigned o) const |
Read-only access to the image value at offset o . | |
lvalue | operator[] (unsigned o) |
Read-write access to the image value at offset o . | |
point | point_at_index (unsigned o) const |
Give the point at offset o . | |
const vset & | values () const |
Give the set of values of the image. |
Documentation class for the concept of images that have the speed property set to "fastest".
Definition at line 36 of file concept/doc/image_fastest.hh.
typedef void mln::doc::Image< E >::bkd_piter [inherited] |
Backward point iterator associated type.
Definition at line 147 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::coord [inherited] |
Coordinate associated type.
Definition at line 131 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::dpoint [inherited] |
Dpsite associated type.
Definition at line 136 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::fwd_piter [inherited] |
Forward point iterator associated type.
Definition at line 142 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::lvalue [inherited] |
Type returned by the read-write pixel value operator.
Definition at line 52 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::point [inherited] |
Site associated type.
Definition at line 121 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::pset [inherited] |
Point set associated type.
Definition at line 116 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::psite [inherited] |
Point_Site associated type.
Definition at line 126 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::rvalue [inherited] |
Type returned by the read pixel value operator.
Definition at line 48 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::skeleton [inherited] |
Associate type that describes how this type of image is constructed.
Definition at line 64 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::value [inherited] |
Value associated type.
Definition at line 44 of file core/concept/doc/image.hh.
typedef void mln::doc::Image< E >::vset [inherited] |
Value set associated type.
Definition at line 57 of file core/concept/doc/image.hh.
const box<point>& mln::doc::Image< E >::bbox | ( | ) | const [inherited] |
Give a bounding box of the image domain.
This bounding box may be larger than the smallest bounding box (the optimal one). Practically an image type is not obliged to update its bounding box so that it is always optimal.
unsigned mln::doc::Fastest_Image< E >::border | ( | ) |
Give the border thickness.
const value* mln::doc::Fastest_Image< E >::buffer | ( | ) | const |
Give a hook to the value buffer.
int mln::doc::Fastest_Image< E >::delta_index | ( | const dpoint & | dp | ) |
Give the offset corresponding to the delta-point dp
.
[in] | dp | A delta-point. |
const pset& mln::doc::Image< E >::domain | ( | ) | const [inherited] |
Give the definition domain of the image.
bool mln::doc::Image< E >::has | ( | const psite & | p | ) | const [inherited] |
Test if the image owns the point site p
.
p
is possible, that is, does not abort the execution. bool mln::doc::Image< E >::has | ( | const psite & | p | ) | const [inherited] |
Test if p
belongs to the image domain.
[in] | p | A point site. |
p
belongs to the image domain.bool mln::doc::Image< E >::is_valid | ( | ) | const [inherited] |
Test if the image have been initialized.
unsigned mln::doc::Fastest_Image< E >::nelements | ( | ) | const |
Give the number of pixels of the image including those of the virtual border.
unsigned mln::doc::Image< E >::nsites | ( | ) | const [inherited] |
Give the number of points of the image domain.
lvalue mln::doc::Image< E >::operator() | ( | const psite & | p | ) | [inherited] |
Read-write access to the image value located at p
.
[in] | p | A point site. |
p
.p
(assignable). rvalue mln::doc::Image< E >::operator() | ( | const psite & | p | ) | const [inherited] |
Read-only access to the image value located at p
.
[in] | p | A point site. |
p
.p
(not assignable). rvalue mln::doc::Fastest_Image< E >::operator[] | ( | unsigned | o | ) | const |
Read-only access to the image value at offset o
.
[in] | o | An offset. |
o
(not assignable). lvalue mln::doc::Fastest_Image< E >::operator[] | ( | unsigned | o | ) |
Read-write access to the image value at offset o
.
[in] | o | An offset. |
o
(assignable). point mln::doc::Fastest_Image< E >::point_at_index | ( | unsigned | o | ) | const |
Give the point at offset o
.
[in] | o | An offset. |
const vset& mln::doc::Image< E >::values | ( | ) | const [inherited] |
Give the set of values of the image.