vil_load.h

Go to the documentation of this file.

// This is core/vil/vil_load.h
#ifndef vil_load_h_
#define vil_load_h_
//:
// \file
// \brief read an image from a file
//
// vil_load returns a pointer to the base class of a vil_image_view object.
// You can then cast, or assign it to the appropriate type. You must not forget to
// delete the created view.
//
// vil_load_image_resource() returns a smart pointer to vil_image_resource which
// will "read an image from a file". In practice
// it may or may not read the image on creation, but a disk read will take place at
// some point before get_view() returns.
//
// \author awf@robots.ox.ac.uk
//
// \verbatim
//  Modifications
//     011002 Peter Vanroose - vil_load now respects top-is-first; vil_load_raw not
//     24 Sep 2002 Ian Scott - converted to vil
//\endverbatim

#include <vil/vil_fwd.h>
#include <vil/vil_image_resource.h>
#include <vil/vil_pyramid_image_resource.h>
#include <vxl_config.h>

//: Load an image resource object from a file.
// \relatesalso vil_image_resource
vil_image_resource_sptr vil_load_image_resource(char const* filename,
                                                bool verbose = true);

//: Load from a stream.
// Won't use plugins.
// \relatesalso vil_image_resource
vil_image_resource_sptr vil_load_image_resource_raw(vil_stream *,
                                                    bool verbose = true);

//: Load an image resource object from a file.
// Won't use plugins.
// \relatesalso vil_image_resource
vil_image_resource_sptr vil_load_image_resource_raw(char const*,
                                                    bool verbose = true);

//: Load from a filename with a plugin.
// \relatesalso vil_image_resource
vil_image_resource_sptr vil_load_image_resource_plugin(char const*);


//: Load a pyramid image resource object from a file or directory.
// \relatesalso vil_pyramid_image_resource
vil_pyramid_image_resource_sptr
vil_load_pyramid_resource(char const* directory_or_file, bool verbose = true);

//: Convenience function for loading an image into an image view.
// \relatesalso vil_image_view
vil_image_view_base_sptr vil_load(const char *, bool verbose = true);


#if defined(_WIN32) && VXL_USE_WIN_WCHAR_T
//: Load an image resource object from a file.
// \relatesalso vil_image_resource
vil_image_resource_sptr vil_load_image_resource(wchar_t const* filename, bool verbose = true);

//: Load an image resource object from a file.
// Won't use plugins.
vil_image_resource_sptr vil_load_image_resource_raw(wchar_t const*, bool verbose = true);

//: Convenience function for loading an image into an image view.
// \relatesalso vil_image_view
vil_image_view_base_sptr vil_load(const wchar_t *, bool verbose = true);
#endif //defined(_WIN32) && VXL_USE_WIN_WCHAR_T


#endif // vil_load_h_