Functions
vil_bicub_interp.h File Reference

Bicubic interpolation functions for 2D images. More...

#include <cstddef>
#include <cassert>
#include <vil/vil_image_view.h>

Go to the source code of this file.

Functions

template<class T >
double vil_bicub_interp_unsafe (double x, double y, const T *data, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), no bound checks. Requires 1<x<ni-3, 1<y<nj-3. More...
 
template<class T >
double vil_bicub_interp_unsafe (double x, double y, const T *data, int, int, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), no bound checks. Requires 1<x<ni-3, 1<y<nj-3. More...
 
template<class T >
double vil_bicub_interp_raw (double x, double y, const T *data, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), no bound checks. More...
 
template<class T >
double vil_bicub_interp_raw (double x, double y, const T *data, int, int, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), no bound checks. More...
 
template<class T >
double vil_bicub_interp_safe (double x, double y, const T *data, int nx, int ny, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), with bound checks. More...
 
template<class T >
double vil_bicub_interp_safe (const vil_image_view< T > &view, double x, double y, unsigned p=0)
 Compute bicubic interpolation at (x,y), with bound checks. More...
 
template<class T >
double vil_bicub_interp (double x, double y, const T *data, int nx, int ny, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), with minimal bound checks. More...
 
template<class T >
double vil_bicub_interp (const vil_image_view< T > &view, double x, double y, unsigned p=0)
 Compute bicubic interpolation at (x,y), with minimal bound checks. More...
 
template<class T >
double vil_bicub_interp_safe_extend (double x, double y, const T *data, int nx, int ny, std::ptrdiff_t xstep, std::ptrdiff_t ystep)
 Compute bicubic interpolation at (x,y), with bound checks. More...
 
template<class T >
double vil_bicub_interp_safe_extend (const vil_image_view< T > &view, double x, double y, unsigned p=0)
 Compute bicubic interpolation at (x,y), with bound checks. More...
 

Detailed Description

Bicubic interpolation functions for 2D images.

The vil bicub source files were derived from the corresponding vil bilin files, thus the vil bilin/bicub source files are very similar. If you modify something in this file, there is a corresponding bilin file that would likely also benefit from the same change.

Definition in file vil_bicub_interp.h.

Function Documentation

◆ vil_bicub_interp() [1/2]

template<class T >
double vil_bicub_interp ( double  x,
double  y,
const T *  data,
int  nx,
int  ny,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)
inline

Compute bicubic interpolation at (x,y), with minimal bound checks.

Image is nx * ny array of Ts. x,y element is data[ystep*y+xstep*x] If (x,y) is outside interpolatable image region and NDEBUG is not defined the code will fail an ASSERT. The safe interpolatable region is [1,nx-2]*[1,ny-2].

Definition at line 99 of file vil_bicub_interp.h.

◆ vil_bicub_interp() [2/2]

template<class T >
double vil_bicub_interp ( const vil_image_view< T > &  view,
double  x,
double  y,
unsigned  p = 0 
)
inline

Compute bicubic interpolation at (x,y), with minimal bound checks.

If (x,y) is outside interpolatable image region and NDEBUG is not defined the code will fail an ASSERT. The safe interpolatable region is [1,view.ni()-2]*[1,view.nj()-2].

Definition at line 116 of file vil_bicub_interp.h.

◆ vil_bicub_interp_raw() [1/2]

template<class T >
double vil_bicub_interp_raw ( double  x,
double  y,
const T *  data,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)

Compute bicubic interpolation at (x,y), no bound checks.

Image is nx * ny array of Ts. x,y element is data[xstep*x+ystep*y] No bound checks are done.

Definition at line 67 of file vil_bicub_interp.hxx.

◆ vil_bicub_interp_raw() [2/2]

template<class T >
double vil_bicub_interp_raw ( double  x,
double  y,
const T *  data,
int  ,
int  ,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)
inline

Compute bicubic interpolation at (x,y), no bound checks.

Image is nx * ny array of Ts. x,y element is data[xstep*x+ystep*y] No bound checks are done. This is a version of vil_bicub_interp_raw with the same function signature as vil_bicub_interp_safe.

Definition at line 57 of file vil_bicub_interp.h.

◆ vil_bicub_interp_safe() [1/2]

template<class T >
double vil_bicub_interp_safe ( double  x,
double  y,
const T *  data,
int  nx,
int  ny,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)
inline

Compute bicubic interpolation at (x,y), with bound checks.

Image is nx * ny array of Ts. x,y element is data[xstep*x+ystep*y] If (x,y) is outside interpolatable image region, zero is returned. The safe interpolatable region is [1,nx-2]*[1,ny-2].

Definition at line 69 of file vil_bicub_interp.h.

◆ vil_bicub_interp_safe() [2/2]

template<class T >
double vil_bicub_interp_safe ( const vil_image_view< T > &  view,
double  x,
double  y,
unsigned  p = 0 
)
inline

Compute bicubic interpolation at (x,y), with bound checks.

If (x,y) is outside interpolatable image region, zero is returned. The safe interpolatable region is [1,view.ni()-2]*[1,view.nj()-2].

Definition at line 85 of file vil_bicub_interp.h.

◆ vil_bicub_interp_safe_extend() [1/2]

template<class T >
double vil_bicub_interp_safe_extend ( double  x,
double  y,
const T *  data,
int  nx,
int  ny,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)
inline

Compute bicubic interpolation at (x,y), with bound checks.

Image is nx * ny array of Ts. x,y element is data[nx*y+x] If (x,y) is outside safe interpolatable image region, nearest pixel value is returned. The safe interpolatable region is [1,nx-2]*[1,ny-2].

Definition at line 129 of file vil_bicub_interp.h.

◆ vil_bicub_interp_safe_extend() [2/2]

template<class T >
double vil_bicub_interp_safe_extend ( const vil_image_view< T > &  view,
double  x,
double  y,
unsigned  p = 0 
)
inline

Compute bicubic interpolation at (x,y), with bound checks.

If (x,y) is outside safe interpolatable image region, nearest pixel value is returned. The safe interpolatable region is [1,view.ni()-2]*[1,view.nj()-2].

Definition at line 145 of file vil_bicub_interp.h.

◆ vil_bicub_interp_unsafe() [1/2]

template<class T >
double vil_bicub_interp_unsafe ( double  x,
double  y,
const T *  data,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)

Compute bicubic interpolation at (x,y), no bound checks. Requires 1<x<ni-3, 1<y<nj-3.

Image is nx * ny array of Ts. x,y element is data[xstep*x+ystep*y] No bound checks are done.

Definition at line 30 of file vil_bicub_interp.hxx.

◆ vil_bicub_interp_unsafe() [2/2]

template<class T >
double vil_bicub_interp_unsafe ( double  x,
double  y,
const T *  data,
int  ,
int  ,
std::ptrdiff_t  xstep,
std::ptrdiff_t  ystep 
)
inline

Compute bicubic interpolation at (x,y), no bound checks. Requires 1<x<ni-3, 1<y<nj-3.

Image is nx * ny array of Ts. x,y element is data[xstep*x+ystep*y] No bound checks are done. This is a version of vil_bicub_interp_unsafe with the same function signature as vil_bicub_interp_safe.

Definition at line 34 of file vil_bicub_interp.h.