chroma - Chroma is a high performance optical photon simulation for particle physics detectors

diff options

author	Stan Seibert <stan@mtrr.org>	2011-10-17 10:21:47 -0400
committer	tlatorre <tlatorre@uchicago.edu>	2021-05-09 08:42:38 -0700
commit	8a81439a976c926e3ff43bd680dab087e13aa3bf (patch)
tree	1db7892e5f55a82521ec6e78ac9eb46d1e87d67d /doc/source/chroma.pdf
parent	5562ab260eabbdc29a64a17ef1c9ab6e4a05224e (diff)
download	chroma-8a81439a976c926e3ff43bd680dab087e13aa3bf.tar.gz chroma-8a81439a976c926e3ff43bd680dab087e13aa3bf.tar.bz2 chroma-8a81439a976c926e3ff43bd680dab087e13aa3bf.zip

OK, we really do need to call the garbage collector this frequently.

Diffstat (limited to 'doc/source/chroma.pdf')

0 files changed, 0 insertions, 0 deletions

h { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */

Rendering Tools
===============

.. module:: chroma

There are three different ways to render a geometry: you can explicitly create a :class:`Camera` instance, call the function :func:`view`, or use the script `chroma-cam`.

Example:
        >>> chroma.view(chroma.make.cube())

.. image:: images/cube.png
   :height: 100px

To control the camera refer to the following table and :ref:`camera_hotkeys`.

.. _camera_controls:

============== =========== ===========================
Thing You Do   Modifier    Thing That Happens
============== =========== ===========================
click and drag             rotate camera around object
click and drag shift       translate camera
click and drag control     rotate camera
mouse wheel                zoom
============== =========== ===========================


.. _camera_hotkeys:

Camera Hotkeys
--------------

========= ===============================
Command   Thing That Happens
========= ===============================
alt       toggle fine motion
F11       toggle fullscreen
escape    quit
=         increase the alpha depth by one
\-        decrease the alpha depth by one
pagedown  move down through the bounding volume hierarchy tree
pageup    move up through the bounding volume hierarchy tree
3         toggle 3d mode
g         toggle 3d colors between red/cyan and green/magenta
F12       take a screenshot
m         make a movie
F5 [#f1]_ toggle hybrid monte carlo rendering mode
F6 [#f2]_ place a light source at the camera's current location
F7 [#f2]_ add another light source at the camera's current location
========= ===============================

.. rubric:: Footnotes

.. [#f1] The hybrid monte carlo rendering mode requires the geometry have surfaces with a non-zero diffuse reflection probability.

.. [#f2] Only available in hybrid monte carlo rendering mode.

The Camera Class
----------------

.. class:: Camera(geometry, size=(800,600), device_id=None)

   The :class:`Camera` class uses :mod:`pygame` to render a geometry.
   :class:`Camera` objects inherit from :class:`multiprocessing.Process` so
   that you can render multiple geometries in separate windows at the same
   time. 

   .. method:: start()

      Create a :mod:`pygame` window, intialize CUDA, and start the camera.


context:
space:
mode: