LightField Dataset
==================

.. _lightfield_schema:

Schema for light field dataset metadata

.. note::

   The following top-level properties are **required**: ``name``, ``category``, ``original-format``, ``url``, ``original-size``, ``encode-size``.


Properties
----------

.. _lightfield_schema_name:


[Required] ``name``
~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > name``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``string``
   * - **Required**
     - Yes

Unique name identifying the light field dataset

**Example(s):**

.. code-block:: json

   "Danger_de_Mort"

.. code-block:: json

   "Bikes"

.. code-block:: json

   "tarot"

.. _lightfield_schema_category:


[Required] ``category``
~~~~~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > category``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``string``
   * - **Required**
     - Yes

Type of light field capture system

**Example(s):**

.. code-block:: json

   "lenslets"

.. code-block:: json

   "hdcas"

.. _lightfield_schema_original_format:


[Required] ``original-format``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > original-format``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``string``
   * - **Required**
     - Yes

File format of the source images

**Example(s):**

.. code-block:: json

   "ppm"

.. code-block:: json

   "png"

.. code-block:: json

   "yuv"

.. _lightfield_schema_url:


[Required] ``url``
~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > url``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``string``
   * - **Required**
     - Yes

Download URL for the dataset archive

**Example(s):**

.. code-block:: json

   "https://plenodb.jpeg.org/lf/pleno_lf/Danger_de_Mort.zip"

.. code-block:: json

   "https://plenodb.jpeg.org/lf/pleno_lf/Bikes.zip"

.. _lightfield_schema_target_rates:


[Optional] ``target-rates``
~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > target-rates``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``array of number``
   * - **Required**
     - No

Target bitrates for encoding (used with hdcas)

**Example(s):**

.. code-block:: json

   [
       0.005,
       0.02,
       0.1,
       0.75
   ]

.. _lightfield_schema_original_size:


[Required] ``original-size``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > original-size``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``object``
   * - **Required**
     - Yes

Original dimensions before any processing

.. _lightfield_schema_original_size_view_height:


[Required] ``view-height``
^^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > original-size > view-height``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   434

.. code-block:: json

   1024

.. _lightfield_schema_original_size_view_width:


[Required] ``view-width``
^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > original-size > view-width``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   625

.. code-block:: json

   1024

.. _lightfield_schema_original_size_number_of_rows:


[Required] ``number-of-rows``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > original-size > number-of-rows``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   15

.. code-block:: json

   17

.. _lightfield_schema_original_size_number_of_columns:


[Required] ``number-of-columns``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > original-size > number-of-columns``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   15

.. code-block:: json

   17

.. _lightfield_schema_pre_processing:


[Optional] ``pre-processing``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > pre-processing``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``object``
   * - **Required**
     - No

Optional preprocessing steps applied. For example, in Set2 2K sub, views were subsampled (step_width=3, step-height=2) and renamed for encoder compatibility.

Original view filenames:
002_000, 005_000, ..., 095_000, 098_000
002_002, 005_002, ..., 098_002
...
002_020, 005_020, ..., 098_020

Renamed to (JPLM-compatible):
000_000, 001_000, ..., 031_000, 032_000
000_001, 001_001, ..., 032_001
...
000_010, 001_010, ..., 032_010

.. _lightfield_schema_pre_processing_resize:


[Optional] ``resize``
^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > pre-processing > resize``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``object``
   * - **Required**
     - No

.. _lightfield_schema_pre_processing_resize_initial_width:


[Optional] ``initial-width``
''''''''''''''''''''''''''''

*Path:* ``LightField Dataset > pre-processing > resize > initial-width``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - No

**Example(s):**

.. code-block:: json

   2

.. _lightfield_schema_pre_processing_resize_initial_height:


[Optional] ``initial-height``
'''''''''''''''''''''''''''''

*Path:* ``LightField Dataset > pre-processing > resize > initial-height``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - No

**Example(s):**

.. code-block:: json

   2

.. _lightfield_schema_pre_processing_resize_step_width:


[Optional] ``step_width``
'''''''''''''''''''''''''

*Path:* ``LightField Dataset > pre-processing > resize > step_width``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - No

**Example(s):**

.. code-block:: json

   3

.. _lightfield_schema_pre_processing_resize_step_height:


[Optional] ``step-height``
''''''''''''''''''''''''''

*Path:* ``LightField Dataset > pre-processing > resize > step-height``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - No

**Example(s):**

.. code-block:: json

   2

.. _lightfield_schema_encode_size:


[Required] ``encode-size``
~~~~~~~~~~~~~~~~~~~~~~~~~~

*Path:* ``LightField Dataset > encode-size``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``object``
   * - **Required**
     - Yes

Dimensions used during encoding

.. _lightfield_schema_encode_size_view_height:


[Required] ``view-height``
^^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > encode-size > view-height``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   434

.. code-block:: json

   1024

.. _lightfield_schema_encode_size_view_width:


[Required] ``view-width``
^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > encode-size > view-width``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   625

.. code-block:: json

   1024

.. _lightfield_schema_encode_size_number_of_rows:


[Required] ``number-of-rows``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > encode-size > number-of-rows``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   11

.. code-block:: json

   17

.. _lightfield_schema_encode_size_number_of_columns:


[Required] ``number-of-columns``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Path:* ``LightField Dataset > encode-size > number-of-columns``

.. list-table::
   :widths: 30 70
   :header-rows: 0

   * - **Type**
     - ``integer``
   * - **Required**
     - Yes

**Example(s):**

.. code-block:: json

   11

.. code-block:: json

   17