Public Types | Public Member Functions

mln::image1d< T > Struct Template Reference
[Basic types]

Basic 1D image class. More...

#include <image1d.hh>

Inherits image_primary< T, box1d, image1d< T > >.

List of all members.

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.
T & element (unsigned i)
 Read-write access to the i-th image value (including the border).
const T & element (unsigned i) const
 Read-only access to the i-th image value (including the border).
bool has (const point1d &p) const
 Test if p is valid.
 image1d (unsigned ninds, unsigned bdr=border::thickness)
 Constructor with the number of indices and the border thickness.
 image1d ()
 Constructor without argument.
 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.

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.


Member Typedef Documentation

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

Return type of read-write access.

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

Return type of read-only access.

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

Skeleton.

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

Value associated type.


Constructor & Destructor Documentation

template<typename T >
mln::image1d< T >::image1d (  )  [inline]

Constructor without argument.

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

Constructor with the number of indices and the border thickness.

References mln::make::box1d().

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

Constructor with a box and the border thickness.


Member Function Documentation

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

Give the bounding box domain.

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

Give the border thickness.

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

Give a hook to the value buffer.

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

Give a hook to the value buffer.

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

Give the offset corresponding to the delta-point dp.

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

Give the definition domain.

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

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

References mln::image1d< T >::nelements().

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

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

References mln::image1d< T >::nelements().

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

Test if p is valid.

Referenced by mln::image1d< T >::operator()().

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

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

Referenced by mln::image1d< T >::element(), and mln::image1d< T >::point_at_index().

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

Give the number of indexes.

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

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

References mln::image1d< T >::has().

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

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

References mln::image1d< T >::has().

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

Give the point corresponding to the offset o.

References mln::image1d< T >::nelements().