Modules | |
C API | |
iOS glue | |
Functions | |
bool | cv::haveImageReader (const String &filename) |
Returns true if the specified image can be decoded by OpenCV. More... | |
bool | cv::haveImageWriter (const String &filename) |
Returns true if an image with the specified filename can be encoded by OpenCV. More... | |
Mat | cv::imdecode (InputArray buf, int flags) |
Reads an image from a buffer in memory. More... | |
Mat | cv::imdecode (InputArray buf, int flags, Mat *dst) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
bool | cv::imencode (const String &ext, InputArray img, std::vector< uchar > &buf, const std::vector< int > ¶ms=std::vector< int >()) |
Encodes an image into a memory buffer. More... | |
Mat | cv::imread (const String &filename, int flags=IMREAD_COLOR) |
Loads an image from a file. More... | |
bool | cv::imreadmulti (const String &filename, std::vector< Mat > &mats, int flags=IMREAD_ANYCOLOR) |
Loads a multi-page image from a file. More... | |
bool | cv::imwrite (const String &filename, InputArray img, const std::vector< int > ¶ms=std::vector< int >()) |
Saves an image to a specified file. More... | |
enum cv::ImreadModes |
#include <opencv2/imgcodecs.hpp>
Imread flags.
enum cv::ImwriteFlags |
#include <opencv2/imgcodecs.hpp>
Imwrite flags.
Enumerator | |
---|---|
IMWRITE_JPEG_QUALITY | For JPEG, it can be a quality from 0 to 100 (the higher is the better). Default value is 95. |
IMWRITE_JPEG_PROGRESSIVE | Enable JPEG features, 0 or 1, default is False. |
IMWRITE_JPEG_OPTIMIZE | Enable JPEG features, 0 or 1, default is False. |
IMWRITE_JPEG_RST_INTERVAL | JPEG restart interval, 0 - 65535, default is 0 - no restart. |
IMWRITE_JPEG_LUMA_QUALITY | Separate luma quality level, 0 - 100, default is 0 - don't use. |
IMWRITE_JPEG_CHROMA_QUALITY | Separate chroma quality level, 0 - 100, default is 0 - don't use. |
IMWRITE_PNG_COMPRESSION | For PNG, it can be the compression level from 0 to 9. A higher value means a smaller size and longer compression time. If specified, strategy is changed to IMWRITE_PNG_STRATEGY_DEFAULT (Z_DEFAULT_STRATEGY). Default value is 1 (best speed setting). |
IMWRITE_PNG_STRATEGY | One of cv::ImwritePNGFlags, default is IMWRITE_PNG_STRATEGY_RLE. |
IMWRITE_PNG_BILEVEL | Binary level PNG, 0 or 1, default is 0. |
IMWRITE_PXM_BINARY | For PPM, PGM, or PBM, it can be a binary format flag, 0 or 1. Default value is 1. |
IMWRITE_EXR_TYPE | |
IMWRITE_WEBP_QUALITY | override EXR storage type (FLOAT (FP32) is default) For WEBP, it can be a quality from 1 to 100 (the higher is the better). By default (without any parameter) and for quality above 100 the lossless compression is used. |
IMWRITE_PAM_TUPLETYPE | For PAM, sets the TUPLETYPE field to the corresponding string value that is defined for the format. |
IMWRITE_TIFF_RESUNIT | For TIFF, use to specify which DPI resolution unit to set; see libtiff documentation for valid values. |
IMWRITE_TIFF_XDPI | For TIFF, use to specify the X direction DPI. |
IMWRITE_TIFF_YDPI | For TIFF, use to specify the Y direction DPI. |
IMWRITE_TIFF_COMPRESSION | For TIFF, use to specify the image compression scheme. See libtiff for integer constants corresponding to compression formats. Note, for images whose depth is CV_32F, only libtiff's SGILOG compression scheme is used. For other supported depths, the compression scheme can be specified by this flag; LZW compression is the default. |
IMWRITE_JPEG2000_COMPRESSION_X1000 | For JPEG2000, use to specify the target compression rate (multiplied by 1000). The value can be from 0 to 1000. Default is 1000. |
enum cv::ImwritePAMFlags |
#include <opencv2/imgcodecs.hpp>
Imwrite PAM specific tupletype flags used to define the 'TUPETYPE' field of a PAM file.
Enumerator | |
---|---|
IMWRITE_PAM_FORMAT_NULL | |
IMWRITE_PAM_FORMAT_BLACKANDWHITE | |
IMWRITE_PAM_FORMAT_GRAYSCALE | |
IMWRITE_PAM_FORMAT_GRAYSCALE_ALPHA | |
IMWRITE_PAM_FORMAT_RGB | |
IMWRITE_PAM_FORMAT_RGB_ALPHA |
enum cv::ImwritePNGFlags |
#include <opencv2/imgcodecs.hpp>
Imwrite PNG specific flags used to tune the compression algorithm.
These flags will be modify the way of PNG image compression and will be passed to the underlying zlib processing stage.
bool cv::haveImageReader | ( | const String & | filename | ) |
#include <opencv2/imgcodecs.hpp>
Returns true if the specified image can be decoded by OpenCV.
filename | File name of the image |
bool cv::haveImageWriter | ( | const String & | filename | ) |
#include <opencv2/imgcodecs.hpp>
Returns true if an image with the specified filename can be encoded by OpenCV.
filename | File name of the image |
Mat cv::imdecode | ( | InputArray | buf, |
int | flags | ||
) |
#include <opencv2/imgcodecs.hpp>
Reads an image from a buffer in memory.
The function imdecode reads an image from the specified buffer in the memory. If the buffer is too short or contains invalid data, the function returns an empty matrix ( Mat::data==NULL ).
See cv::imread for the list of supported formats and flags description.
buf | Input array or vector of bytes. |
flags | The same flags as in cv::imread, see cv::ImreadModes. |
Mat cv::imdecode | ( | InputArray | buf, |
int | flags, | ||
Mat * | dst | ||
) |
#include <opencv2/imgcodecs.hpp>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
buf | |
flags | |
dst | The optional output placeholder for the decoded matrix. It can save the image reallocations when the function is called repeatedly for images of the same size. |
bool cv::imencode | ( | const String & | ext, |
InputArray | img, | ||
std::vector< uchar > & | buf, | ||
const std::vector< int > & | params = std::vector< int >() |
||
) |
#include <opencv2/imgcodecs.hpp>
Encodes an image into a memory buffer.
The function imencode compresses the image and stores it in the memory buffer that is resized to fit the result. See cv::imwrite for the list of supported formats and flags description.
ext | File extension that defines the output format. |
img | Image to be written. |
buf | Output buffer resized to fit the compressed image. |
params | Format-specific parameters. See cv::imwrite and cv::ImwriteFlags. |
Mat cv::imread | ( | const String & | filename, |
int | flags = IMREAD_COLOR |
||
) |
#include <opencv2/imgcodecs.hpp>
Loads an image from a file.
The function imread loads an image from the specified file and returns it. If the image cannot be read (because of missing file, improper permissions, unsupported or invalid format), the function returns an empty matrix ( Mat::data==NULL ).
Currently, the following file formats are supported:
filename | Name of file to be loaded. |
flags | Flag that can take values of cv::ImreadModes |
bool cv::imreadmulti | ( | const String & | filename, |
std::vector< Mat > & | mats, | ||
int | flags = IMREAD_ANYCOLOR |
||
) |
#include <opencv2/imgcodecs.hpp>
Loads a multi-page image from a file.
The function imreadmulti loads a multi-page image from the specified file into a vector of Mat objects.
filename | Name of file to be loaded. |
flags | Flag that can take values of cv::ImreadModes, default with cv::IMREAD_ANYCOLOR. |
mats | A vector of Mat objects holding each page, if more than one. |
bool cv::imwrite | ( | const String & | filename, |
InputArray | img, | ||
const std::vector< int > & | params = std::vector< int >() |
||
) |
#include <opencv2/imgcodecs.hpp>
Saves an image to a specified file.
The function imwrite saves the image to the specified file. The image format is chosen based on the filename extension (see cv::imread for the list of extensions). In general, only 8-bit single-channel or 3-channel (with 'BGR' channel order) images can be saved using this function, with these exceptions:
If the format, depth or channel order is different, use Mat::convertTo and cv::cvtColor to convert it before saving. Or, use the universal FileStorage I/O functions to save the image to XML or YAML format.
The sample below shows how to create a BGRA image and save it to a PNG file. It also demonstrates how to set custom compression parameters:
filename | Name of the file. |
img | Image to be saved. |
params | Format-specific parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .) see cv::ImwriteFlags |