git commit -m "first commit"

navigations/geometry2/tf2_ros/doc/conf.py

@@ -0,0 +1,204 @@
+# -*- coding: utf-8 -*-
+#
+# tf documentation build configuration file, created by
+# sphinx-quickstart on Mon Jun  1 14:21:53 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.imgmath']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'tf'
+copyright = u'2009, Willow Garage, Inc.'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'tfdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'tf.tex', u'stereo\\_utils Documentation',
+   u'Tully Foote and Eitan Marder-Eppstein', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    'http://docs.python.org/': None,
+    'http://docs.opencv.org/3.0-last-rst/': None,
+    'http://docs.scipy.org/doc/numpy' : None
+    }
+
+autoclass_content = "both"

navigations/geometry2/tf2_ros/doc/index.rst

@@ -0,0 +1,48 @@
+tf2_ros Overview
+================
+
+This is the Python API reference for the tf2_ros package.
+
+To broadcast transforms using ROS:
+- Call :meth:`rospy.init` to initialize a node.
+- Construct a :class:`tf2_ros.TransformBroadcaster`.
+- Pass a :class:`geometry_msgs.TransformStamped` message to :meth:`tf2_ros.TransformBroadcaster.sendTransform`.
+
+    - Alternatively, pass a vector of :class:`geometry_msgs.TransformStamped` messages.
+
+To listen for transforms using ROS:
+- Construct an instance of a class that implements :class:`tf2_ros.BufferInterface`.
+
+    - :class:`tf2_ros.Buffer` is the standard implementation which offers a tf2_frames service that can respond to requests with a :class:`tf2_msgs.FrameGraph`.
+    - :class:`tf2_ros.BufferClient` uses an :class:`actionlib.SimpleActionClient` to wait for the requested transform to become available.
+
+- Pass the :class:`tf2_ros.Buffer` to the constructor of :class:`tf2_ros.TransformListener`.
+    - Optionally, pass a :class:`ros.NodeHandle` (otherwise TransformListener will connect to the node for the process).
+    - Optionally, specify if the TransformListener runs in its own thread or not.
+
+- Use :meth:`tf2_ros.BufferInterface.transform` to apply a transform on the tf server to an input frame.
+    - Or, check if a transform is available with :meth:`tf2_ros.BufferInterface.can_transform`.
+    - Then, call :meth:`tf2_ros.BufferInterface.lookup_transform` to get the transform between two frames.
+
+For more information, see the tf2 tutorials: http://wiki.ros.org/tf2/Tutorials
+
+Or, get an `overview`_ of data type conversion methods in geometry_experimental packages.
+
+See http://wiki.ros.org/tf2/Tutorials for more detailed usage.
+
+.. _overview: http://wiki.ros.org/tf2/Tutorials/Migration/DataConversions
+
+Classes and Exceptions
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+    tf2_ros
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

navigations/geometry2/tf2_ros/doc/mainpage.dox

@@ -0,0 +1,41 @@
+/**
+\mainpage
+\htmlinclude manifest.html
+
+\b tf2_ros is the C++ ROS wrapper around the tf2 transform library.
+
+\section codeapi Code API
+
+To broadcast transforms using ROS:
+- Call ros::init() to initialize a node.
+- Construct a tf2_ros::TransformBroadcaster.
+- Pass a geometry_msgs::TransformStamped message to tf2_ros::TransformBroadcaster::sendTransform().
+  - Alternatively, pass a vector of geometry_msgs::TransformStamped messages.
+- Use tf2_ros::StaticTransformBroadcaster for "latching" behavior when transforms that are not expected to change.
+
+To listen for transforms using ROS:
+- Construct an instance of a class that implements tf2_ros::BufferInterface.
+  - tf2_ros::Buffer is the standard implementation which offers a tf2_frames service that can respond to requests with a tf2_msgs::FrameGraph.
+  - tf2_ros::BufferClient uses an actionlib::SimpleActionClient to wait for the requested transform to become available.
+    - It should be used with a tf2_ros::BufferServer, which offers the corresponding actionlib::ActionSErver.
+- Pass the tf2_ros::Buffer to the constructor of tf2_ros::TransformListener.
+  - Optionally, pass a ros::NodeHandle (otherwise TransformListener will connect to the node for the process).
+  - Optionally, specify if the TransformListener runs in its own thread or not.
+- Use tf2_ros::BufferInterface::transform() to apply a transform on the tf server to an input frame.
+  - Or, check if a transform is available with tf2_ros::BufferInterface::canTransform().
+  - Then, call tf2_ros::BufferInterface::lookupTransform() to get the transform between two frames.
+- Construct a tf2_ros::MessageFilter with the TransformListener to apply a transformation to incoming frames.
+  - This is especially useful when streaming sensor data.
+
+List of exceptions thrown in this library:
+- tf2::LookupException
+- tf2::ConnectivityException
+- tf2::ExtrapolationException
+- tf2::InvalidArgumentException
+- tf2::TimeoutException
+- tf2::TransformException
+
+For more information, see the tf2 tutorials: http://wiki.ros.org/tf2/Tutorials
+
+Or, get an <A HREF="http://wiki.ros.org/tf2/Tutorials/Migration/DataConversions">overview</A> of data type conversion methods in geometry_experimental packages.
+*/

navigations/geometry2/tf2_ros/doc/tf2_ros.rst

@@ -0,0 +1,73 @@
+tf_ros2 Python API
+==================
+
+Exceptions
+----------
+
+.. exception:: tf2.TransformException
+
+    base class for tf exceptions.  Because :exc:`tf2.TransformException` is the
+    base class for other exceptions, you can catch all tf exceptions
+    by writing::
+
+        try:
+            # do some tf2 work
+        except tf2.TransformException:
+            print "some tf2 exception happened"
+        
+
+.. exception:: tf2.ConnectivityException
+
+   subclass of :exc:`TransformException`.
+   Raised when that the fixed_frame tree is not connected between the frames requested.
+
+.. exception:: tf2.LookupException
+
+   subclass of :exc:`TransformException`.
+   Raised when a tf method has attempted to access a frame, but
+   the frame is not in the graph.
+   The most common reason for this is that the frame is not
+   being published, or a parent frame was not set correctly 
+   causing the tree to be broken.  
+
+.. exception:: tf2.ExtrapolationException
+
+   subclass of :exc:`TransformException`
+   Raised when a tf method would have required extrapolation beyond current limits.
+
+
+.. exception:: tf2.InvalidArgumentException
+
+   subclass of :exc:`TransformException`.
+   Raised when the arguments to the method are called improperly formed.  An example of why this might be raised is if an argument is nan. 
+
+.. autoexception:: tf2_ros.buffer_interface.TypeException
+
+.. autoexception:: tf2_ros.buffer_interface.NotImplementedException
+
+
+BufferInterface
+---------------
+.. autoclass:: tf2_ros.buffer_interface.BufferInterface
+    :members:
+
+Buffer
+------
+.. autoclass:: tf2_ros.buffer.Buffer
+    :members:
+
+BufferClient
+------------
+.. autoclass:: tf2_ros.buffer_client.BufferClient
+    :members:
+
+
+TransformBroadcaster
+--------------------
+.. autoclass:: tf2_ros.transform_broadcaster.TransformBroadcaster
+    :members:
+
+TransformListener
+-----------------
+.. autoclass:: tf2_ros.transform_listener.TransformListener
+    :members: