:orphan:

xscale_match
************

Specifies how to match compound stimuli in the stimulus-response history to the ``xscale`` parameter,
when ``xscale`` is not ``all``.

If the simulation does not contain any compound stimuli, this parameter has no effect.

.. note::

  The parameter ``xscale_match`` has no effect if ``xscale`` is ``all``.

Syntax
------

::

  xscale_match = exact
  xscale_match = subset

Default
-------

``subset``

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

``xscale_match = subset`` will make plotting commands include compound stimuli in the stimulus-response history that are supersets of the ``xscale`` parameter value.

----

``xscale_match = exact`` will make plotting commands include only compound stimuli in the stimulus-response history that exactly matches the ``xscale`` parameter value.


Example
-------

If the history is

::

  e1 -> b1 -> e1,e2 -> b2 -> e1,e2,e3 -> b3

and

::

  xscale_match = subset

then

::

  xscale = e1
  @vplot ...

will include e1, (e1,e2), and (e1,e2,e3) in the x-axis data of the ``@vplot``, and

::

  xscale e1,e2
  @vplot ...

will include (e1,e2), and (e1,e2,e3) in the x-axis data of the ``@vplot``.

Example
-------

If the history is

::

  e1 -> b1 -> e1,e2 -> b2 -> e1,e2,e3 -> b3

and

::

  xscale_match = exact

then

::

  xscale e1
  @vplot ...

will include only e1 in the x-axis data of the ``@vplot``.

::

  xscale e1,e2
  @vplot ...

will include only (e1,e2) in the x-axis data of the ``@vplot``.