vil_copy.h

Go to the documentation of this file.

// This is core/vil/vil_copy.h
#ifndef vil_copy_h_
#define vil_copy_h_
//:
// \file
// \brief Various image copying functions.
// \author Ian Scott - Manchester
// \date 4 Oct 2002

#include <vil/vil_fwd.h>


//: Copy src to dest, without changing dest's view parameters.
// This is useful if you want to copy an image into a window on another image.
// src and dest must have identical sizes, and types.
//  O(size).
// \relatesalso vil_image_view
template<class T>
void vil_copy_reformat(const vil_image_view<T> &src, vil_image_view<T> &dest);

//: Copy src to window in dest.
// Size of window is defined by src.
//  O(src.size).
// \relatesalso vil_image_view
template<class T>
void vil_copy_to_window(const vil_image_view<T> &src, vil_image_view<T> &dest,
                        unsigned i0, unsigned j0);

//: Deep copy src to dest.
//  O(size).
// \relatesalso vil_image_view
template<class T>
void vil_copy_deep(const vil_image_view<T> &src, vil_image_view<T> &dest);

//: Create a deep copy of an image, with completely new underlying memory.
//  O(size).
// \relatesalso vil_image_view
template<class T>
vil_image_view<T> vil_copy_deep(const vil_image_view<T> &src);


//: Copy src to dest.
// This is useful if you want to copy on image into a window on another image.
// src and dest must have identical sizes, and pixel-types. Returns false if the copy
// failed.
//  O(size).
// \relatesalso vil_image_resource
bool vil_copy_deep(const vil_image_resource_sptr &src, vil_image_resource_sptr &dest);

//: Creates an in memory vil_image_resource and copies the src to it.
// The size and pixel type of the return vil_image_resource is determined by src
// O(size)
// \relatesalso vil_image_resource
vil_image_resource_sptr vil_copy_deep( const vil_image_resource_sptr &src );

#endif // vil_copy_h_