.. _ome-files-info:

ome-files info
============

Synopsis
--------

**ome-files info** [*options*] *file*

Description
-----------

:program:`ome-files info` displays the metadata for an image file,
including the :emphasis:`core` and :emphasis:`original` metadata, and
can optionally display and validate the :emphasis:`OME-XML` metadata.

.. note::

  Viewing is currently restricted to the first series of an OME-TIFF
  file using the 2013-06 schema.  Future releases will extend this to
  multiple series, all schema versions and additional file formats.

Options
-------

.. option:: -h, --help

  Show this manual page.

.. option:: -u, --usage

  Show usage summary.

.. option:: -V, --version

  Print version information.

.. option:: --debug

  Show debug output.

.. option:: -q, --quiet

  Show less output.

.. option:: -v, --verbose

  Show more output.

.. option:: --format=reader

  Use the specified format reader (UNIMPLEMENTED).

.. option:: --flat

  Flatten subresolutions.

.. option:: --no-flat (default)

  Do not flatten subresolutions.

.. option:: --merge

  Combine separate channels into an RGB image (UNIMPLEMENTED).

.. option:: --no-merge

  Do not combine separate channels into an RGB image (UNIMPLEMENTED) (default).

.. option:: --group

  Group files in multi-file datasets into a single dataset.

.. option:: --no-group

  files in multi-file datasets are not into a single dataset (default).

.. option:: --stitch

  Group files with similar names (UNIMPLEMENTED).

.. option:: --no-stitch

  Do not group files with similar names (UNIMPLEMENTED) (default).

.. option:: --separate

  Separate an RGB image into separate channels (UNIMPLEMENTED).

.. option:: --no-separate

  Do not separate an RGB image into separate channels (UNIMPLEMENTED) (default).

.. option:: series=n

  Use the specified series (UNIMPLEMENTED).

.. option:: resolution=n

  Use the specified sub-resolution (only if not flattened with --flat)
  (UNIMPLEMENTED).

.. option:: --input-order=XY[ZTC]

  Override the dimension input order (UNIMPLEMENTED).

.. option:: --output-order=XY[ZTC]

  Override the dimension output order (UNIMPLEMENTED).

.. option:: --core

  Display core metadata (default).

.. option:: --no-core

  Do not display core metadata.

.. option:: --orig

  Display original format-specific global and series metadata (default).

.. option:: --no-orig

  Do not display original format-specific global and series metadata.

.. option:: --filter

  Filter original format-specific global and series metadata.

.. option:: --no-filter

  Do not filter original format-specific global and series metadata (default).

.. option:: --omexml

  Display OME-XML metadata.

.. option:: --no-omexml

  Do not display OME-XML metadata (default).

.. option:: --validate

  Validate OME-XML metadata (default).  Note this will only have an
  effect if :option:`--omexml` is used.

.. option:: --no-validate

  Do not validate OME-XML metadata.

.. option:: --sa

  Display structured annotations (default) (UNIMPLEMENTED).

.. option:: --no-sa

  Do not display structured annotations.

.. option:: --used

  Display used files (default).

.. option:: --no-used

  Do not display used files.
