OpenCV 5.0.0-pre
Open Source Computer Vision
Loading...
Searching...
No Matches
imgcodecs.hpp File Reference
#include "opencv2/core.hpp"
Include dependency graph for imgcodecs.hpp:
This graph shows which files directly or indirectly include this file:

Classes

class  cv::ImageCollection
 To read multi-page images on demand. More...
 
struct  cv::ImageCollection::iterator
 

Namespaces

namespace  cv
 

Enumerations

enum  cv::ImreadModes {
  cv::IMREAD_UNCHANGED = -1 ,
  cv::IMREAD_GRAYSCALE = 0 ,
  cv::IMREAD_COLOR_BGR = 1 ,
  cv::IMREAD_COLOR = 1 ,
  cv::IMREAD_ANYDEPTH = 2 ,
  cv::IMREAD_ANYCOLOR = 4 ,
  cv::IMREAD_LOAD_GDAL = 8 ,
  cv::IMREAD_REDUCED_GRAYSCALE_2 = 16 ,
  cv::IMREAD_REDUCED_COLOR_2 = 17 ,
  cv::IMREAD_REDUCED_GRAYSCALE_4 = 32 ,
  cv::IMREAD_REDUCED_COLOR_4 = 33 ,
  cv::IMREAD_REDUCED_GRAYSCALE_8 = 64 ,
  cv::IMREAD_REDUCED_COLOR_8 = 65 ,
  cv::IMREAD_IGNORE_ORIENTATION = 128 ,
  cv::IMREAD_COLOR_RGB = 256
}
 Imread flags. More...
 
enum  cv::ImwriteEXRCompressionFlags {
  cv::IMWRITE_EXR_COMPRESSION_NO = 0 ,
  cv::IMWRITE_EXR_COMPRESSION_RLE = 1 ,
  cv::IMWRITE_EXR_COMPRESSION_ZIPS = 2 ,
  cv::IMWRITE_EXR_COMPRESSION_ZIP = 3 ,
  cv::IMWRITE_EXR_COMPRESSION_PIZ = 4 ,
  cv::IMWRITE_EXR_COMPRESSION_PXR24 = 5 ,
  cv::IMWRITE_EXR_COMPRESSION_B44 = 6 ,
  cv::IMWRITE_EXR_COMPRESSION_B44A = 7 ,
  cv::IMWRITE_EXR_COMPRESSION_DWAA = 8 ,
  cv::IMWRITE_EXR_COMPRESSION_DWAB = 9
}
 
enum  cv::ImwriteEXRTypeFlags {
  cv::IMWRITE_EXR_TYPE_HALF = 1 ,
  cv::IMWRITE_EXR_TYPE_FLOAT = 2
}
 
enum  cv::ImwriteFlags {
  cv::IMWRITE_JPEG_QUALITY = 1 ,
  cv::IMWRITE_JPEG_PROGRESSIVE = 2 ,
  cv::IMWRITE_JPEG_OPTIMIZE = 3 ,
  cv::IMWRITE_JPEG_RST_INTERVAL = 4 ,
  cv::IMWRITE_JPEG_LUMA_QUALITY = 5 ,
  cv::IMWRITE_JPEG_CHROMA_QUALITY = 6 ,
  cv::IMWRITE_JPEG_SAMPLING_FACTOR = 7 ,
  cv::IMWRITE_PNG_COMPRESSION = 16 ,
  cv::IMWRITE_PNG_STRATEGY = 17 ,
  cv::IMWRITE_PNG_BILEVEL = 18 ,
  cv::IMWRITE_PXM_BINARY = 32 ,
  cv::IMWRITE_EXR_TYPE = (3 << 4) + 0 ,
  cv::IMWRITE_EXR_COMPRESSION = (3 << 4) + 1 ,
  cv::IMWRITE_EXR_DWA_COMPRESSION_LEVEL = (3 << 4) + 2 ,
  cv::IMWRITE_WEBP_QUALITY = 64 ,
  cv::IMWRITE_HDR_COMPRESSION = (5 << 4) + 0 ,
  cv::IMWRITE_PAM_TUPLETYPE = 128 ,
  cv::IMWRITE_TIFF_RESUNIT = 256 ,
  cv::IMWRITE_TIFF_XDPI = 257 ,
  cv::IMWRITE_TIFF_YDPI = 258 ,
  cv::IMWRITE_TIFF_COMPRESSION = 259 ,
  cv::IMWRITE_TIFF_ROWSPERSTRIP = 278 ,
  cv::IMWRITE_TIFF_PREDICTOR = 317 ,
  cv::IMWRITE_JPEG2000_COMPRESSION_X1000 = 272 ,
  cv::IMWRITE_AVIF_QUALITY = 512 ,
  cv::IMWRITE_AVIF_DEPTH = 513 ,
  cv::IMWRITE_AVIF_SPEED = 514
}
 Imwrite flags. More...
 
enum  cv::ImwriteHDRCompressionFlags {
  cv::IMWRITE_HDR_COMPRESSION_NONE = 0 ,
  cv::IMWRITE_HDR_COMPRESSION_RLE = 1
}
 Imwrite HDR specific values for IMWRITE_HDR_COMPRESSION parameter key. More...
 
enum  cv::ImwriteJPEGSamplingFactorParams {
  cv::IMWRITE_JPEG_SAMPLING_FACTOR_411 = 0x411111 ,
  cv::IMWRITE_JPEG_SAMPLING_FACTOR_420 = 0x221111 ,
  cv::IMWRITE_JPEG_SAMPLING_FACTOR_422 = 0x211111 ,
  cv::IMWRITE_JPEG_SAMPLING_FACTOR_440 = 0x121111 ,
  cv::IMWRITE_JPEG_SAMPLING_FACTOR_444 = 0x111111
}
 
enum  cv::ImwritePAMFlags {
  cv::IMWRITE_PAM_FORMAT_NULL = 0 ,
  cv::IMWRITE_PAM_FORMAT_BLACKANDWHITE = 1 ,
  cv::IMWRITE_PAM_FORMAT_GRAYSCALE = 2 ,
  cv::IMWRITE_PAM_FORMAT_GRAYSCALE_ALPHA = 3 ,
  cv::IMWRITE_PAM_FORMAT_RGB = 4 ,
  cv::IMWRITE_PAM_FORMAT_RGB_ALPHA = 5
}
 Imwrite PAM specific tupletype flags used to define the 'TUPLETYPE' field of a PAM file. More...
 
enum  cv::ImwritePNGFlags {
  cv::IMWRITE_PNG_STRATEGY_DEFAULT = 0 ,
  cv::IMWRITE_PNG_STRATEGY_FILTERED = 1 ,
  cv::IMWRITE_PNG_STRATEGY_HUFFMAN_ONLY = 2 ,
  cv::IMWRITE_PNG_STRATEGY_RLE = 3 ,
  cv::IMWRITE_PNG_STRATEGY_FIXED = 4
}
 Imwrite PNG specific flags used to tune the compression algorithm. More...
 
enum  cv::ImwriteTiffCompressionFlags {
  cv::IMWRITE_TIFF_COMPRESSION_NONE = 1 ,
  cv::IMWRITE_TIFF_COMPRESSION_CCITTRLE = 2 ,
  cv::IMWRITE_TIFF_COMPRESSION_CCITTFAX3 = 3 ,
  cv::IMWRITE_TIFF_COMPRESSION_CCITT_T4 = 3 ,
  cv::IMWRITE_TIFF_COMPRESSION_CCITTFAX4 = 4 ,
  cv::IMWRITE_TIFF_COMPRESSION_CCITT_T6 = 4 ,
  cv::IMWRITE_TIFF_COMPRESSION_LZW = 5 ,
  cv::IMWRITE_TIFF_COMPRESSION_OJPEG = 6 ,
  cv::IMWRITE_TIFF_COMPRESSION_JPEG = 7 ,
  cv::IMWRITE_TIFF_COMPRESSION_T85 = 9 ,
  cv::IMWRITE_TIFF_COMPRESSION_T43 = 10 ,
  cv::IMWRITE_TIFF_COMPRESSION_NEXT = 32766 ,
  cv::IMWRITE_TIFF_COMPRESSION_CCITTRLEW = 32771 ,
  cv::IMWRITE_TIFF_COMPRESSION_PACKBITS = 32773 ,
  cv::IMWRITE_TIFF_COMPRESSION_THUNDERSCAN = 32809 ,
  cv::IMWRITE_TIFF_COMPRESSION_IT8CTPAD = 32895 ,
  cv::IMWRITE_TIFF_COMPRESSION_IT8LW = 32896 ,
  cv::IMWRITE_TIFF_COMPRESSION_IT8MP = 32897 ,
  cv::IMWRITE_TIFF_COMPRESSION_IT8BL = 32898 ,
  cv::IMWRITE_TIFF_COMPRESSION_PIXARFILM = 32908 ,
  cv::IMWRITE_TIFF_COMPRESSION_PIXARLOG = 32909 ,
  cv::IMWRITE_TIFF_COMPRESSION_DEFLATE = 32946 ,
  cv::IMWRITE_TIFF_COMPRESSION_ADOBE_DEFLATE = 8 ,
  cv::IMWRITE_TIFF_COMPRESSION_DCS = 32947 ,
  cv::IMWRITE_TIFF_COMPRESSION_JBIG = 34661 ,
  cv::IMWRITE_TIFF_COMPRESSION_SGILOG = 34676 ,
  cv::IMWRITE_TIFF_COMPRESSION_SGILOG24 = 34677 ,
  cv::IMWRITE_TIFF_COMPRESSION_JP2000 = 34712 ,
  cv::IMWRITE_TIFF_COMPRESSION_LERC = 34887 ,
  cv::IMWRITE_TIFF_COMPRESSION_LZMA = 34925 ,
  cv::IMWRITE_TIFF_COMPRESSION_ZSTD = 50000 ,
  cv::IMWRITE_TIFF_COMPRESSION_WEBP = 50001 ,
  cv::IMWRITE_TIFF_COMPRESSION_JXL = 50002
}
 
enum  cv::ImwriteTiffPredictorFlags {
  cv::IMWRITE_TIFF_PREDICTOR_NONE = 1 ,
  cv::IMWRITE_TIFF_PREDICTOR_HORIZONTAL = 2 ,
  cv::IMWRITE_TIFF_PREDICTOR_FLOATINGPOINT = 3
}
 

Functions

CV_EXPORTS_W bool cv::haveImageReader (const String &filename)
 Checks if the specified image file can be decoded by OpenCV.
 
CV_EXPORTS_W bool cv::haveImageWriter (const String &filename)
 Checks if the specified image file or specified file extension can be encoded by OpenCV.
 
CV_EXPORTS_W size_t cv::imcount (const String &filename, int flags=IMREAD_ANYCOLOR)
 Returns the number of images inside the given file.
 
CV_EXPORTS_W Mat cv::imdecode (InputArray buf, int flags)
 Reads an image from a buffer in memory.
 
CV_EXPORTS Mat cv::imdecode (InputArray buf, int flags, Mat *dst)
 
CV_EXPORTS_W bool cv::imdecodemulti (InputArray buf, int flags, CV_OUT std::vector< Mat > &mats, const cv::Range &range=Range::all())
 Reads a multi-page image from a buffer in memory.
 
CV_EXPORTS_W bool cv::imencode (const String &ext, InputArray img, CV_OUT std::vector< uchar > &buf, const std::vector< int > &params=std::vector< int >())
 Encodes an image into a memory buffer.
 
CV_EXPORTS_W bool cv::imencodemulti (const String &ext, InputArrayOfArrays imgs, CV_OUT std::vector< uchar > &buf, const std::vector< int > &params=std::vector< int >())
 Encodes array of images into a memory buffer.
 
CV_EXPORTS_W Mat cv::imread (const String &filename, int flags=IMREAD_COLOR_BGR)
 Loads an image from a file.
 
CV_EXPORTS_W void cv::imread (const String &filename, OutputArray dst, int flags=IMREAD_COLOR_BGR)
 Loads an image from a file.
 
CV_EXPORTS_W bool cv::imreadmulti (const String &filename, CV_OUT std::vector< Mat > &mats, int flags=IMREAD_ANYCOLOR)
 Loads a multi-page image from a file.
 
CV_EXPORTS_W bool cv::imreadmulti (const String &filename, CV_OUT std::vector< Mat > &mats, int start, int count, int flags=IMREAD_ANYCOLOR)
 Loads images of a multi-page image from a file.
 
CV_EXPORTS_W bool cv::imwrite (const String &filename, InputArray img, const std::vector< int > &params=std::vector< int >())
 Saves an image to a specified file.
 
static CV_WRAP bool cv::imwritemulti (const String &filename, InputArrayOfArrays img, const std::vector< int > &params=std::vector< int >())
 multi-image overload for bindings