Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::image1d< T > Struct Template Reference

Basic 1D image class. More...

#include <image1d.hh>

Inherits mln::internal::image_primary< T, box1d, image1d< T > >.

Public Types

typedef T & lvalue
 Return type of read-write access.
 
typedef const T & rvalue
 Return type of read-only access.
 
typedef image1d< tag::value_< T > > skeleton
 Skeleton.
 
typedef T value
 Value associated type.
 

Public Member Functions

const box1dbbox () const
 Give the bounding box domain.
 
unsigned border () const
 Give the border thickness.
 
const T * buffer () const
 Give a hook to the value buffer.
 
T * buffer ()
 Give a hook to the value buffer.
 
int delta_index (const dpoint1d &dp) const
 Give the offset corresponding to the delta-point dp.
 
const box1ddomain () const
 Give the definition domain.
 
const T & element (unsigned i) const
 Read-only access to the i-th image value (including the border).
 
T & element (unsigned i)
 Read-write access to the i-th image value (including the border).
 
bool has (const point1d &p) const
 Test if p is valid.
 
 image1d ()
 Constructor without argument.
 
 image1d (unsigned ninds, unsigned bdr=border::thickness)
 Constructor with the number of indices and the border thickness.
 
 image1d (const box1d &b, unsigned bdr=border::thickness)
 Constructor with a box and the border thickness.
 
unsigned nelements () const
 Give the number of cells (points including border ones).
 
unsigned ninds () const
 Give the number of indexes.
 
const T & operator() (const point1d &p) const
 Read-only access to the image value located at point p.
 
T & operator() (const point1d &p)
 Read-write access to the image value located at point p.
 
point1d point_at_index (unsigned i) const
 Give the point corresponding to the offset o.
 
const box1dvbbox () const
 virtual box, i.e., box including the virtual border
 

Detailed Description

template<typename T>
struct mln::image1d< T >

Basic 1D image class.

The parameter T is the type of pixel values. This image class stores data in memory and has a virtual border with constant thickness before and after data.

Definition at line 155 of file image1d.hh.

Member Typedef Documentation

template<typename T>
typedef T& mln::image1d< T >::lvalue

Return type of read-write access.

Definition at line 167 of file image1d.hh.

template<typename T>
typedef const T& mln::image1d< T >::rvalue

Return type of read-only access.

Definition at line 164 of file image1d.hh.

template<typename T>
typedef image1d< tag::value_<T> > mln::image1d< T >::skeleton

Skeleton.

Definition at line 170 of file image1d.hh.

template<typename T>
typedef T mln::image1d< T >::value

Value associated type.

Definition at line 161 of file image1d.hh.

Constructor & Destructor Documentation

template<typename T >
image1d< T >::image1d ( )
inline

Constructor without argument.

Definition at line 371 of file image1d.hh.

template<typename T >
image1d< T >::image1d ( unsigned  ninds,
unsigned  bdr = border::thickness 
)
inline

Constructor with the number of indices and the border thickness.

Definition at line 384 of file image1d.hh.

template<typename T >
image1d< T >::image1d ( const box1d b,
unsigned  bdr = border::thickness 
)
inline

Constructor with a box and the border thickness.

Definition at line 377 of file image1d.hh.

Member Function Documentation

template<typename T >
const box1d & image1d< T >::bbox ( ) const
inline

Give the bounding box domain.

Definition at line 411 of file image1d.hh.

template<typename T >
unsigned image1d< T >::border ( ) const
inline

Give the border thickness.

Definition at line 429 of file image1d.hh.

template<typename T >
const T * image1d< T >::buffer ( ) const
inline

Give a hook to the value buffer.

Definition at line 520 of file image1d.hh.

template<typename T >
T * image1d< T >::buffer ( )
inline

Give a hook to the value buffer.

Definition at line 529 of file image1d.hh.

template<typename T >
int image1d< T >::delta_index ( const dpoint1d dp) const
inline

Give the offset corresponding to the delta-point dp.

Definition at line 538 of file image1d.hh.

template<typename T >
const box1d & image1d< T >::domain ( ) const
inline

Give the definition domain.

Definition at line 402 of file image1d.hh.

template<typename T >
const T & image1d< T >::element ( unsigned  i) const
inline

Read-only access to the i-th image value (including the border).

Definition at line 502 of file image1d.hh.

template<typename T >
T & image1d< T >::element ( unsigned  i)
inline

Read-write access to the i-th image value (including the border).

Definition at line 511 of file image1d.hh.

template<typename T >
bool image1d< T >::has ( const point1d p) const
inline

Test if p is valid.

Definition at line 447 of file image1d.hh.

template<typename T >
unsigned image1d< T >::nelements ( ) const
inline

Give the number of cells (points including border ones).

Definition at line 438 of file image1d.hh.

template<typename T >
unsigned image1d< T >::ninds ( ) const
inline

Give the number of indexes.

Definition at line 483 of file image1d.hh.

template<typename T >
const T & image1d< T >::operator() ( const point1d p) const
inline

Read-only access to the image value located at point p.

Definition at line 456 of file image1d.hh.

template<typename T >
T & image1d< T >::operator() ( const point1d p)
inline

Read-write access to the image value located at point p.

Definition at line 465 of file image1d.hh.

template<typename T >
point1d image1d< T >::point_at_index ( unsigned  i) const
inline

Give the point corresponding to the offset o.

Definition at line 548 of file image1d.hh.

template<typename T >
const box1d & image1d< T >::vbbox ( ) const
inline

virtual box, i.e., box including the virtual border

Definition at line 420 of file image1d.hh.