Macros | Functions
vil_image_view.hxx File Reference

Represent images of one or more planes of Ts. More...

#include <string>
#include <cstdlib>
#include <cmath>
#include <ostream>
#include <cstring>
#include <algorithm>
#include "vil_image_view.h"
#include <cassert>
#include <vil/vil_pixel_format.h>
#include <vil/vil_exception.h>

Go to the source code of this file.

Macros

#define VIL_IMAGE_VIEW_INSTANTIATE(T)
 

Functions

template<class T >
bool convert_components_from_planes (vil_image_view< T > &lhs, const vil_image_view_base &rhs_base)
 Convert planes to components from planes, or do nothing if types are wrong. More...
 
template<>
bool convert_components_from_planes (vil_image_view< float > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< double > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< bool > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< vxl_sbyte > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< vxl_byte > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< vxl_int_16 > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< vxl_uint_16 > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< vxl_int_32 > &, const vil_image_view_base &)
 
template<>
bool convert_components_from_planes (vil_image_view< vxl_uint_32 > &, const vil_image_view_base &)
 
template<class T >
bool convert_planes_from_components (vil_image_view< T > &, const vil_image_view_base &)
 Convert components to planes from planes, or do nothing if types are wrong. More...
 
template<>
bool convert_planes_from_components (vil_image_view< vil_rgb< vxl_byte > > &lhs, const vil_image_view_base &rhs)
 
template<>
bool convert_planes_from_components (vil_image_view< vil_rgba< vxl_uint_16 > > &lhs, const vil_image_view_base &rhs)
 
template<>
bool convert_planes_from_components (vil_image_view< vxl_byte > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< vxl_sbyte > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< vxl_uint_16 > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< vxl_int_16 > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< vxl_uint_32 > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< vxl_int_32 > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< float > &lhs, const vil_image_view_base &rhs_base)
 
template<>
bool convert_planes_from_components (vil_image_view< double > &lhs, const vil_image_view_base &rhs_base)
 
template<class T >
bool vil_image_view_deep_equality (const vil_image_view< T > &lhs, const vil_image_view< T > &rhs)
 True if the actual images are identical. More...
 
template<class T >
std::string vil_image_view_type_name (T *)
 

Detailed Description

Represent images of one or more planes of Ts.

Author
Ian Scott

Note: To keep down size of vil_image_view Please think carefully before adding any new methods. In particular any methods that provide new views (e.g. vil_plane) will be more usefully provided as external functions. - IMS. In that case, use the "relates" keyword of Doxygen to link the documentation of that function to the vil_image_view class.

  Modifications
   23 Oct.2003 - Peter Vanroose - Added support for 64-bit int pixels

Definition in file vil_image_view.hxx.

Macro Definition Documentation

◆ VIL_IMAGE_VIEW_INSTANTIATE

#define VIL_IMAGE_VIEW_INSTANTIATE (   T)
Value:
template <> std::string vil_image_view_type_name(T*) \
{ return std::string("vil_image_view<" #T ">"); } \
template class vil_image_view<T >; \
Concrete view of image data of type T held in memory.
Definition: vil_fwd.h:13
bool vil_image_view_deep_equality(const vil_image_view< T > &lhs, const vil_image_view< T > &rhs)
True if the actual images are identical.
std::string vil_image_view_type_name(T *)

Definition at line 886 of file vil_image_view.hxx.

Function Documentation

◆ convert_components_from_planes() [1/10]

template<class T >
bool convert_components_from_planes ( vil_image_view< T > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Convert planes to components from planes, or do nothing if types are wrong.

Definition at line 180 of file vil_image_view.hxx.

◆ convert_components_from_planes() [2/10]

template<>
bool convert_components_from_planes ( vil_image_view< float > &  ,
const vil_image_view_base  
)
inline

Definition at line 209 of file vil_image_view.hxx.

◆ convert_components_from_planes() [3/10]

template<>
bool convert_components_from_planes ( vil_image_view< double > &  ,
const vil_image_view_base  
)
inline

Definition at line 214 of file vil_image_view.hxx.

◆ convert_components_from_planes() [4/10]

template<>
bool convert_components_from_planes ( vil_image_view< bool > &  ,
const vil_image_view_base  
)
inline

Definition at line 219 of file vil_image_view.hxx.

◆ convert_components_from_planes() [5/10]

template<>
bool convert_components_from_planes ( vil_image_view< vxl_sbyte > &  ,
const vil_image_view_base  
)
inline

Definition at line 224 of file vil_image_view.hxx.

◆ convert_components_from_planes() [6/10]

template<>
bool convert_components_from_planes ( vil_image_view< vxl_byte > &  ,
const vil_image_view_base  
)
inline

Definition at line 229 of file vil_image_view.hxx.

◆ convert_components_from_planes() [7/10]

template<>
bool convert_components_from_planes ( vil_image_view< vxl_int_16 > &  ,
const vil_image_view_base  
)
inline

Definition at line 234 of file vil_image_view.hxx.

◆ convert_components_from_planes() [8/10]

template<>
bool convert_components_from_planes ( vil_image_view< vxl_uint_16 > &  ,
const vil_image_view_base  
)
inline

Definition at line 239 of file vil_image_view.hxx.

◆ convert_components_from_planes() [9/10]

template<>
bool convert_components_from_planes ( vil_image_view< vxl_int_32 > &  ,
const vil_image_view_base  
)
inline

Definition at line 244 of file vil_image_view.hxx.

◆ convert_components_from_planes() [10/10]

template<>
bool convert_components_from_planes ( vil_image_view< vxl_uint_32 > &  ,
const vil_image_view_base  
)
inline

Definition at line 249 of file vil_image_view.hxx.

◆ convert_planes_from_components() [1/11]

template<class T >
bool convert_planes_from_components ( vil_image_view< T > &  ,
const vil_image_view_base  
)
inline

Convert components to planes from planes, or do nothing if types are wrong.

Definition at line 269 of file vil_image_view.hxx.

◆ convert_planes_from_components() [2/11]

template<>
bool convert_planes_from_components ( vil_image_view< vil_rgb< vxl_byte > > &  lhs,
const vil_image_view_base rhs 
)
inline

Definition at line 274 of file vil_image_view.hxx.

◆ convert_planes_from_components() [3/11]

template<>
bool convert_planes_from_components ( vil_image_view< vil_rgba< vxl_uint_16 > > &  lhs,
const vil_image_view_base rhs 
)
inline

Definition at line 292 of file vil_image_view.hxx.

◆ convert_planes_from_components() [4/11]

template<>
bool convert_planes_from_components ( vil_image_view< vxl_byte > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 311 of file vil_image_view.hxx.

◆ convert_planes_from_components() [5/11]

template<>
bool convert_planes_from_components ( vil_image_view< vxl_sbyte > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 335 of file vil_image_view.hxx.

◆ convert_planes_from_components() [6/11]

template<>
bool convert_planes_from_components ( vil_image_view< vxl_uint_16 > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 359 of file vil_image_view.hxx.

◆ convert_planes_from_components() [7/11]

template<>
bool convert_planes_from_components ( vil_image_view< vxl_int_16 > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 383 of file vil_image_view.hxx.

◆ convert_planes_from_components() [8/11]

template<>
bool convert_planes_from_components ( vil_image_view< vxl_uint_32 > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 407 of file vil_image_view.hxx.

◆ convert_planes_from_components() [9/11]

template<>
bool convert_planes_from_components ( vil_image_view< vxl_int_32 > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 431 of file vil_image_view.hxx.

◆ convert_planes_from_components() [10/11]

template<>
bool convert_planes_from_components ( vil_image_view< float > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 507 of file vil_image_view.hxx.

◆ convert_planes_from_components() [11/11]

template<>
bool convert_planes_from_components ( vil_image_view< double > &  lhs,
const vil_image_view_base rhs_base 
)
inline

Definition at line 531 of file vil_image_view.hxx.

◆ vil_image_view_deep_equality()

template<class T >
bool vil_image_view_deep_equality ( const vil_image_view< T > &  lhs,
const vil_image_view< T > &  rhs 
)

True if the actual images are identical.

$\bigwedge_{i,j,p} {\textstyle src}(i,j,p) == {\textstyle dest}(i,j,p)$ The data may be formatted differently in each memory chunk. O(size).

Definition at line 855 of file vil_image_view.hxx.

◆ vil_image_view_type_name()

template<class T >
std::string vil_image_view_type_name ( T *  )