Spaces:

AshanGimhana
/

Aging_MouthReplace

Paused

App Files Files Community

Aging_MouthReplace / dlibs /docs /dlib /image_loader /jpeg_loader_abstract.h.html

AshanGimhana

Upload folder using huggingface_hub

9375c9a verified 3 months ago

raw

history blame

9.29 kB

	<html><!-- Created using the cpp_pretty_printer from the dlib C++ library. See http://dlib.net for updates. --><head><title>dlib C++ Library - jpeg_loader_abstract.h</title></head><body bgcolor='white'><pre>
	<font color='#009900'>// Copyright (C) 2010 Davis E. King ([email protected]), Nils Labugt
	</font><font color='#009900'>// License: Boost Software License See LICENSE.txt for the full license.
	</font><font color='#0000FF'>#undef</font> DLIB_JPEG_IMPORT_ABSTRACT
	<font color='#0000FF'>#ifdef</font> DLIB_JPEG_IMPORT_ABSTRACT

	<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='image_loader_abstract.h.html'>image_loader_abstract.h</a>"
	<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../algs.h.html'>../algs.h</a>"
	<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../pixel.h.html'>../pixel.h</a>"
	<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../dir_nav.h.html'>../dir_nav.h</a>"
	<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../image_processing/generic_image.h.html'>../image_processing/generic_image.h</a>"

	<font color='#0000FF'>namespace</font> dlib
	<b>{</b>

	<font color='#0000FF'>class</font> <b><a name='jpeg_loader'></a>jpeg_loader</b> : noncopyable
	<b>{</b>
	<font color='#009900'>/*!
	INITIAL VALUE
	Defined by the constructors

	WHAT THIS OBJECT REPRESENTS
	This object represents a class capable of loading JPEG image files.
	Once an instance of it is created to contain a JPEG file from
	disk you can obtain the image stored in it via get_image().
	!*/</font>

	<font color='#0000FF'>public</font>:

	<b><a name='jpeg_loader'></a>jpeg_loader</b><font face='Lucida Console'>(</font>
	<font color='#0000FF'>const</font> <font color='#0000FF'><u>char</u></font><font color='#5555FF'>*</font> filename
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	ensures
	- loads the JPEG file with the given file name into this object
	throws
	- std::bad_alloc
	- image_load_error
	This exception is thrown if there is some error that prevents
	us from loading the given JPEG file.
	!*/</font>

	<b><a name='jpeg_loader'></a>jpeg_loader</b><font face='Lucida Console'>(</font>
	<font color='#0000FF'>const</font> std::string<font color='#5555FF'>&</font> filename
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	ensures
	- loads the JPEG file with the given file name into this object
	throws
	- std::bad_alloc
	- image_load_error
	This exception is thrown if there is some error that prevents
	us from loading the given JPEG file.
	!*/</font>

	<b><a name='jpeg_loader'></a>jpeg_loader</b><font face='Lucida Console'>(</font>
	<font color='#0000FF'>const</font> dlib::file<font color='#5555FF'>&</font> f
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	ensures
	- loads the JPEG file with the given file name into this object
	throws
	- std::bad_alloc
	- image_load_error
	This exception is thrown if there is some error that prevents
	us from loading the given JPEG file.
	!*/</font>

	<b><a name='jpeg_loader'></a>jpeg_loader</b><font face='Lucida Console'>(</font>
	<font color='#0000FF'>const</font> <font color='#0000FF'><u>unsigned</u></font> <font color='#0000FF'><u>char</u></font><font color='#5555FF'>*</font> imgbuffer,
	<font color='#0000FF'><u>size_t</u></font> buffersize
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	ensures
	- loads the JPEG from memory imgbuffer of size buffersize into this object
	throws
	- image_load_error
	This exception is thrown if there is some error that prevents
	us from loading the given JPEG buffer.
	!*/</font>

	~<b><a name='jpeg_loader'></a>jpeg_loader</b><font face='Lucida Console'>(</font>
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	ensures
	- all resources associated with *this has been released
	!*/</font>

	<font color='#0000FF'><u>bool</u></font> <b><a name='is_gray'></a>is_gray</b><font face='Lucida Console'>(</font>
	<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
	<font color='#009900'>/*!
	ensures
	- if (this object contains a grayscale image) then
	- returns true
	- else
	- returns false
	!*/</font>

	<font color='#0000FF'><u>bool</u></font> <b><a name='is_rgb'></a>is_rgb</b><font face='Lucida Console'>(</font>
	<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
	<font color='#009900'>/*!
	ensures
	- if (this object contains a 3 channel RGB image) then
	- returns true
	- else
	- returns false
	!*/</font>

	<font color='#0000FF'>template</font><font color='#5555FF'><</font>
	<font color='#0000FF'>typename</font> image_type
	<font color='#5555FF'>></font>
	<font color='#0000FF'><u>void</u></font> <b><a name='get_image'></a>get_image</b><font face='Lucida Console'>(</font>
	image_type<font color='#5555FF'>&</font> img
	<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
	<font color='#009900'>/*!
	requires
	- image_type == an image object that implements the interface defined in
	dlib/image_processing/generic_image.h
	ensures
	- loads the JPEG image stored in this object into img
	!*/</font>

	<b>}</b>;

	<font color='#009900'>// ----------------------------------------------------------------------------------------
	</font>
	<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
	<font color='#0000FF'>typename</font> image_type
	<font color='#5555FF'>></font>
	<font color='#0000FF'><u>void</u></font> <b><a name='load_jpeg'></a>load_jpeg</b> <font face='Lucida Console'>(</font>
	image_type<font color='#5555FF'>&</font> image,
	<font color='#0000FF'>const</font> std::string<font color='#5555FF'>&</font> file_name
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	requires
	- image_type == an image object that implements the interface defined in
	dlib/image_processing/generic_image.h
	ensures
	- performs: jpeg_loader(file_name).get_image(image);
	!*/</font>

	<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
	<font color='#0000FF'>typename</font> image_type
	<font color='#5555FF'>></font>
	<font color='#0000FF'><u>void</u></font> <b><a name='load_jpeg'></a>load_jpeg</b> <font face='Lucida Console'>(</font>
	image_type<font color='#5555FF'>&</font> image,
	<font color='#0000FF'>const</font> <font color='#0000FF'><u>unsigned</u></font> <font color='#0000FF'><u>char</u></font><font color='#5555FF'>*</font> imgbuff,
	<font color='#0000FF'><u>size_t</u></font> imgbuffsize
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	requires
	- image_type == an image object that implements the interface defined in
	dlib/image_processing/generic_image.h
	ensures
	- performs: jpeg_loader(imgbuff, imgbuffsize).get_image(image);
	!*/</font>

	<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
	<font color='#0000FF'>typename</font> image_type
	<font color='#5555FF'>></font>
	<font color='#0000FF'><u>void</u></font> <b><a name='load_jpeg'></a>load_jpeg</b> <font face='Lucida Console'>(</font>
	image_type<font color='#5555FF'>&</font> image,
	<font color='#0000FF'>const</font> <font color='#0000FF'><u>char</u></font><font color='#5555FF'>*</font> imgbuff,
	<font color='#0000FF'><u>size_t</u></font> imgbuffsize
	<font face='Lucida Console'>)</font>;
	<font color='#009900'>/*!
	requires
	- image_type == an image object that implements the interface defined in
	dlib/image_processing/generic_image.h
	ensures
	- performs: jpeg_loader((unsigned char*)imgbuff, imgbuffsize).get_image(image);
	!*/</font>

	<font color='#009900'>// ----------------------------------------------------------------------------------------
	</font>
	<b>}</b>

	<font color='#0000FF'>#endif</font> <font color='#009900'>// DLIB_JPEG_IMPORT_ABSTRACT
	</font>

	</pre></body></html>