class_docstr: Support for tifffile as backend.
  
  Parameters
  ----------
  request : iio.Request
      A request object that represents the users intent. It provides a
      standard interface for a plugin to access the various ImageResources.
      Check the docs for details.
  kwargs : Any
      Additional kwargs are forwarded to tifffile's constructor, i.e.
      to ``TiffFile`` for reading or ``TiffWriter`` for writing.
class_docstr_tok: ["Support","for","tifffile","as","backend",".","Parameters","--","--","--","--","--","request",":","iio.Request","A","request","object","that","represents","the","users","intent",".","It","provides","a","standard","interface","for","a","plugin","to","access","the","various","ImageResources",".","Check","the","docs","for","details",".","kwargs",":","Any","Additional","kwargs","are","forwarded","to","tifffile","'s","constructor",",","i.e",".","to","``","TiffFile","``","for","reading","or","``","TiffWriter","``","for","writing","."]
docstr: Standardized metadata.
  
  The properties returned depend on the value of both ``index`` and
  ``page``. ``index`` selects a series and ``page`` allows selecting a
  single page from the selected series. If ``index=Ellipsis``, ``page`` is
  understood as a flat index, i.e., the selection ignores individual
  series inside the file. If ``index=Ellipsis`` and ``page=None`` then
  global (file-level) properties are returned. If ``index=Ellipsis``
  and ``page=...``, file-level properties for the flattened index are
  returned.
  
  Parameters
  ----------
  index : int
      If ``int``, select the ndimage (series) located at that index inside
      the file. If ``Ellipsis`` and ``page`` is ``int`` extract the
      properties of the page located at that (flat) index inside the file.
      If ``Ellipsis`` and ``page=None``, return the properties for the
      batch of all ndimages in the file.
  page : int
      If ``None`` return the properties of the full ndimage. If ``...``
      return the properties of the flattened index. If ``int``,
      return the properties of the page at the selected index only.
  
  Returns
  -------
  image_properties : ImageProperties
      The standardized metadata (properties) of the selected ndimage or series.
docstr_tok: ["Standardized","metadata",".","The","properties","returned","depend","on","the","value","of","both","``","index","``","and","``","page","``",".","``","index","``","selects","a","series","and","``","page","``","allows","selecting","a","single","page","from","the","selected","series",".","If","``","index=Ellipsis","``",",","``","page","``","is","understood","as","a","flat","index",",","i.e.",",","the","selection","ignores","individual","series","inside","the","file",".","If","``","index=Ellipsis","``","and","``","page=None","``","then","global","(","file-level",")","properties","are","returned",".","If","``","index=Ellipsis","``","and","``","page=","...","``",",","file-level","properties","for","the","flattened","index","are","returned",".","Parameters","--","--","--","--","--","index",":","int","If","``","int","``",",","select","the","ndimage","(","series",")","located","at","that","index","inside","the","file",".","If","``","Ellipsis","``","and","``","page","``","is","``","int","``","extract","the","properties","of","the","page","located","at","that","(","flat",")","index","inside","the","file",".","If","``","Ellipsis","``","and","``","page=None","``",",","return","the","properties","for","the","batch","of","all","ndimages","in","the","file",".","page",":","int","If","``","None","``","return","the","properties","of","the","full","ndimage",".","If","``","...","``","return","the","properties","of","the","flattened","index",".","If","``","int","``",",","return","the","properties","of","the","page","at","the","selected","index","only",".","Returns","--","--","--","-","image_properties",":","ImageProperties","The","standardized","metadata","(","properties",")","of","the","selected","ndimage","or","series","."]
code: def properties(
      self, *, index: int = None, page: int = None
  ) -> ImageProperties:
      """Standardized metadata.
  
      The properties returned depend on the value of both ``index`` and
      ``page``. ``index`` selects a series and ``page`` allows selecting a
      single page from the selected series. If ``index=Ellipsis``, ``page`` is
      understood as a flat index, i.e., the selection ignores individual
      series inside the file. If ``index=Ellipsis`` and ``page=None`` then
      global (file-level) properties are returned. If ``index=Ellipsis``
      and ``page=...``, file-level properties for the flattened index are
      returned.
  
      Parameters
      ----------
      index : int
          If ``int``, select the ndimage (series) located at that index inside
          the file. If ``Ellipsis`` and ``page`` is ``int`` extract the
          properties of the page located at that (flat) index inside the file.
          If ``Ellipsis`` and ``page=None``, return the properties for the
          batch of all ndimages in the file.
      page : int
          If ``None`` return the properties of the full ndimage. If ``...``
          return the properties of the flattened index. If ``int``,
          return the properties of the page at the selected index only.
  
      Returns
      -------
      image_properties : ImageProperties
          The standardized metadata (properties) of the selected ndimage or series.
  
      """
      index = index or 0
      page_idx = 0 if page in (None, Ellipsis) else page
  
      if index is Ellipsis:
          target_page = self._fh.pages[page_idx]
      else:
          target_page = self._fh.series[index].pages[page_idx]
  
      if index is Ellipsis and page is None:
          n_series = len(self._fh.series)
          props = ImageProperties(
              shape=(n_series, *target_page.shape),
              dtype=target_page.dtype,
              n_images=n_series,
              is_batch=True,
              spacing=_get_resolution(target_page).get("resolution"),
          )
      elif index is Ellipsis and page is Ellipsis:
          n_pages = len(self._fh.pages)
          props = ImageProperties(
              shape=(n_pages, *target_page.shape),
              dtype=target_page.dtype,
              n_images=n_pages,
              is_batch=True,
              spacing=_get_resolution(target_page).get("resolution"),
          )
      else:
          props = ImageProperties(
              shape=target_page.shape,
              dtype=target_page.dtype,
              is_batch=False,
              spacing=_get_resolution(target_page).get("resolution"),
          )
  
      return props
  
file_path: imageio/imageio/plugins/tifffile_v3.py
imports: from io import BytesIO
  from typing import Any, Dict, Optional, cast
  import warnings
  import numpy
  import tifffile
  from ..core.request import URI_BYTES, InitializationError, Request
  from ..core.v3_plugin_api import ImageProperties, PluginV3
  from ..typing import ArrayLike
label_desc: Use image node_id 6 for calling the TifffilePlugin obj's underlying member method code with example usage: obj.properties() and returns: props