white_two_rows
==============


.. image:: /_static/generated_stimuli/stimuli.whites.white_two_rows.png
   :alt: white_two_rows stimulus example
   :align: center
   :width: 400px



.. centered:: You can find an interactive version of this example `here <../../../demos/stimuli/whites/white_two_rows.html>`__





.. py:function:: stimupy.stimuli.whites.white_two_rows(visual_size=None, ppd=None, shape=None, frequency=None, n_bars=None, bar_width=None, period='ignore', rotation=0.0, intensity_bars=(0.0, 1.0), intensity_target=0.5, target_indices_top=(), target_indices_bottom=(), target_center_offset=None, target_heights=None, origin='corner', round_phase_width=True)


   White's stimulus where targets are placed in two rows (top, bottom) that have the same
   distance from the center.

   :param visual_size: visual size [height, width] of image, in degrees
   :type visual_size: Sequence[Number, Number], Number, or None (default)
   :param ppd: pixels per degree [vertical, horizontal]
   :type ppd: Sequence[Number, Number], Number, or None (default)
   :param shape: shape [height, width] of image, in pixels
   :type shape: Sequence[Number, Number], Number, or None (default)
   :param frequency: spatial frequency of grating, in cycles per degree visual angle
   :type frequency: Number, or None (default)
   :param n_bars: number of bars in the grating
   :type n_bars: int, or None (default)
   :param bar_width: width of a single bar, in degrees visual angle
   :type bar_width: Number, or None (default)
   :param period: ensure whether the grating has "even" number of phases, "odd"
                  number of phases, either or whether not to round the number of
                  phases ("ignore")
   :type period: "even", "odd", "either" or "ignore" (default)
   :param rotation: rotation (in degrees), counterclockwise, by default 0.0 (horizontal)
   :type rotation: float, optional
   :param intensity_bars: intensity value for each bar, by default (1.0, 0.0).
                          Can specify as many intensities as n_bars;
                          If fewer intensities are passed than n_bars, cycles through intensities
   :type intensity_bars: Sequence[float, ...]
   :param intensity_target: intensity value of target
   :type intensity_target: float
   :param target_indices_top: bar indices where top target(s) will be placed. As many targets as ints.
   :type target_indices_top: int or tuple of ints
   :param target_indices_bottom: bar indices where bottom target(s) will be placed. As many targets as ints.
   :type target_indices_bottom: int or tuple of ints
   :param target_center_offset: offset from target centers to image center in degree visual angle.
   :type target_center_offset: float
   :param target_heights: height of targets in degrees visual angle
   :type target_heights: float, or Sequence[float, ...]
   :param origin: if "corner": set origin to upper left corner (default)
                  if "mean": set origin to hypothetical image center
                  if "center": set origin to real center (closest existing value to mean)
   :type origin: "corner", "mean" or "center"
   :param round_phase_width: if True (default), round phase width of grating
   :type round_phase_width: Bool

   :returns: dict with the stimulus (key: "img"),
             mask with integer index for each target (key: "mask"),
             and additional keys containing stimulus parameters
   :rtype: dict[str, Any]

   .. rubric:: References

   White, M. (1979).
       A new effect of pattern on perceived lightness.
       Perception, 8(4), 413-416.
       https://doi.org/10.1068/p080413