// Copyright (C) 2006 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_IMAGE_SAVEr_ABSTRACT_
#ifdef DLIB_IMAGE_SAVEr_ABSTRACT_
#include <iosfwd>
#include "../algs.h"
#include "../pixel.h"
#include "../image_processing/generic_image.h"
namespace dlib
{
class image_save_error : public dlib::error
{
/*!
WHAT THIS OBJECT REPRESENTS
This is an exception used to indicate a failure to save an image.
Its type member variable will be set to EIMAGE_SAVE.
!*/
};
// ----------------------------------------------------------------------------------------
template <
typename image_type
>
void save_bmp (
const image_type& image,
std::ostream& out
);
/*!
requires
- image_type == an image object that implements the interface defined in
dlib/image_processing/generic_image.h or any kind of matrix expression.
ensures
- writes the image to the out stream in the Microsoft Windows BMP format.
- image[0][0] will be in the upper left corner of the image.
- image[image.nr()-1][image.nc()-1] will be in the lower right
corner of the image.
- This routine can save images containing any type of pixel. However, it
will convert all color pixels into rgb_pixel and grayscale pixels into
uint8 type before saving to disk.
throws
- image_save_error
This exception is thrown if there is an error that prevents us
from saving the image.
- std::bad_alloc
!*/
// ----------------------------------------------------------------------------------------
template <
typename image_type
>
void save_bmp (
const image_type& image,
const std::string& file_name
);
/*!
requires
- image_type == an image object that implements the interface defined in
dlib/image_processing/generic_image.h or any kind of matrix expression.
ensures
- opens the file indicated by file_name with an output file stream named fout
and performs:
save_bmp(image,fout);
!*/
// ----------------------------------------------------------------------------------------
/*!
dlib dng file format:
This is a file format I created for this library. It is a lossless
compressed image format that is similar to the PNG format but uses
the dlib PPM compression algorithms instead of the DEFLATE algorithm.
!*/
template <
typename image_type
>
void save_dng (
const image_type& image,
std::ostream& out
);
/*!
requires
- image_type == an image object that implements the interface defined in
dlib/image_processing/generic_image.h or any kind of matrix expression.
ensures
- writes the image to the out stream in the dlib dng format.
- image[0][0] will be in the upper left corner of the image.
- image[image.nr()-1][image.nc()-1] will be in the lower right
corner of the image.
- This routine can save images containing any type of pixel. However, the DNG
format can natively store only the following pixel types: rgb_pixel,
hsi_pixel, rgb_alpha_pixel, uint8, uint16, float, and double.
All other pixel types will be converted into one of these types as
appropriate before being saved to disk.
throws
- image_save_error
This exception is thrown if there is an error that prevents us
from saving the image.
- std::bad_alloc
!*/
// ----------------------------------------------------------------------------------------
template <typename image_type>
void save_dng (
const image_type& image,
const std::string& file_name
);
/*!
requires
- image_type == an image object that implements the interface defined in
dlib/image_processing/generic_image.h or any kind of matrix expression.
ensures
- opens the file indicated by file_name with an output file stream named fout
and performs:
save_dng(image,fout);
!*/
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_IMAGE_SAVEr_ABSTRACT_