
Color
=====

``blue``
--------

``Image`` [Float] **blue** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a GREYSCALE image where each pixel is the blue component
of the RGB original.

----------

**Example 1:** blue()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/blue_plugin_00.png
   :height: 129
   :width: 227



``cie_x``
---------

``Image`` [Float] **cie_x** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a FLOAT image where each pixel is a *x* value in the `CIE
1964 Colorimetric`__ system in range [0, 1).

.. __: http://www.isc.tamu.edu/~astro/color/cie_xyz1964.html

----------

**Example 1:** cie_x()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/cie_x_plugin_00.png
   :height: 129
   :width: 227



``cie_y``
---------

``Image`` [Float] **cie_y** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a FLOAT image where each pixel is a *y* value in the `CIE
1964 Colorimetric`__ system in range [0, 1).

.. __: http://www.isc.tamu.edu/~astro/color/cie_xyz1964.html

----------

**Example 1:** cie_y()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/cie_y_plugin_00.png
   :height: 129
   :width: 227



``cie_z``
---------

``Image`` [Float] **cie_z** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a FLOAT image where each pixel is a *z* value in the `CIE
1964 Colorimetric`__ system in range [0, 1).

.. __: http://www.isc.tamu.edu/~astro/color/cie_xyz1964.html

----------

**Example 1:** cie_z()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/cie_z_plugin_00.png
   :height: 129
   :width: 227



``color_ccs``
-------------

``Image`` [RGB] **color_ccs** (``bool`` *ignore_unlabeled* = True)


:Operates on: ``Image`` [OneBit]
:Returns: ``Image`` [RGB]
:Category: Color
:Defined in: gui_support.py
:Author: Michael Droettboom, Karl MacMillan, and Robert Butz


Returns an RGB image where each connected component of the
image is colored one of eight different colors.  This function can
be used to verify that ``cc_analysis`` is working correctly for your
image.

*ignore_unlabeled*:
  do not colorize unlabeled pixels (pixel value one), but leave them black

.. note:: Connected component analysis must already be performed
          on the image (using cc_analysis_, for example) in order
          for this to work.
      
.. _cc_analysis: segmentation.html#cc-analysis

**Example 1:**

  .. image:: images/color_ccs.png


``cyan``
--------

``Image`` [Float] **cyan** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a GREYSCALE image where each pixel is the cyan component
of the RGB original.

----------

**Example 1:** cyan()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/cyan_plugin_00.png
   :height: 129
   :width: 227



``false_color``
---------------

``Image`` [RGB] **false_color** ()


:Operates on: ``Image`` [Float|GreyScale]
:Returns: ``Image`` [RGB]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a false color representation of the given image.  Low
values are red, mid values are green and high values are blue.
This can help visualize greyscale images that are not *real*
images but are representations of other kinds of data.

----------

**Example 1:** false_color()

..  image:: images/GreyScale_generic.png
   :height: 67
   :width: 96

..  image:: images/false_color_plugin_00.png
   :height: 67
   :width: 96



``green``
---------

``Image`` [Float] **green** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a GREYSCALE image where each pixel is the green component
of the original.

----------

**Example 1:** green()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/green_plugin_00.png
   :height: 129
   :width: 227



``hue``
-------

``Image`` [Float] **hue** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a FLOAT image where each pixel is a hue value in HSV space
in range [0, 1).  Since the hue space is continuous, the shortest
*distance* between 1 and 0 is 0.

----------

**Example 1:** hue()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/hue_plugin_00.png
   :height: 129
   :width: 227



``magenta``
-----------

``Image`` [Float] **magenta** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a GREYSCALE image where each pixel is the magenta
component of the RGB original.

----------

**Example 1:** magenta()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/magenta_plugin_00.png
   :height: 129
   :width: 227



``red``
-------

``Image`` [Float] **red** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a GREYSCALE image where each pixel is the red component of
the RGB original.

----------

**Example 1:** red()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/red_plugin_00.png
   :height: 129
   :width: 227



``saturation``
--------------

``Image`` [Float] **saturation** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a FLOAT image where each pixel is a saturation value in
HSV space in range [0, 1).

----------

**Example 1:** saturation()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/saturation_plugin_00.png
   :height: 129
   :width: 227



``value``
---------

``Image`` [Float] **value** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a FLOAT image where each pixel is a saturation value in
HSV space in range [0, 1).  For more information, Google for HSV color
space.

----------

**Example 1:** value()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/value_plugin_00.png
   :height: 129
   :width: 227



``yellow``
----------

``Image`` [Float] **yellow** ()


:Operates on: ``Image`` [RGB]
:Returns: ``Image`` [Float]
:Category: Color
:Defined in: color.py
:Author: Michael Droettboom and Karl MacMillan


Returns a GREYSCALE image where each pixel is the yellow component
of the RGB original.

----------

**Example 1:** yellow()

..  image:: images/RGB_generic.png
   :height: 129
   :width: 227

..  image:: images/yellow_plugin_00.png
   :height: 129
   :width: 227



