Struct opencv::imgcodecs::ImageCollection

pub struct ImageCollection { /* private fields */ }

To read Multi Page images on demand

The ImageCollection class provides iterator API to read multi page images on demand. Create iterator to the collection of the images and iterate over the collection. Decode the necessary page with operator*.

The performance of page decoding is O(1) if collection is increment sequentially. If the user wants to access random page, then the time Complexity is O(n) because the collection has to be reinitialized every time in order to go to the correct page. However, the intermediate pages are not decoded during the process, so typically it’s quite fast. This is required because multipage codecs does not support going backwards. After decoding the one page, it is stored inside the collection cache. Hence, trying to get Mat object from already decoded page is O(1). If you need memory, you can use .releaseCache() method to release cached index. The space complexity is O(n) if all pages are decoded into memory. The user is able to decode and release images on demand.

Implementations

impl ImageCollection

pub fn default() -> Result<ImageCollection>

pub fn new(filename: &str, flags: i32) -> Result<ImageCollection>

Trait Implementations

impl Boxed for ImageCollection

unsafe fn from_raw( ptr: <ImageCollection as OpenCVFromExtern>::ExternReceive ) -> Self

Wrap the specified raw pointer

fn into_raw( self ) -> <ImageCollection as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <ImageCollection as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self ) -> <ImageCollection as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for ImageCollection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ImageCollection

fn drop(&mut self)

Executes the destructor for this type.

impl ImageCollectionTrait for ImageCollection

fn as_raw_mut_ImageCollection(&mut self) -> *mut c_void

fn init(&mut self, img: &str, flags: i32) -> Result<()>

fn at(&mut self, index: i32) -> Result<Mat>

fn get_mut(&mut self, index: i32) -> Result<Mat>

fn release_cache(&mut self, index: i32) -> Result<()>

fn begin(&mut self) -> Result<ImageCollection_iterator>

fn end(&mut self) -> Result<ImageCollection_iterator>

impl ImageCollectionTraitConst for ImageCollection

fn as_raw_ImageCollection(&self) -> *const c_void

fn size(&self) -> Result<size_t>

impl Send for ImageCollection