Radar Altimeter
===============


**Compute the distance to the ground**


Sensor to compute the distance to the ground

To work properly, the ground and relevant obstacles must be marked as Actor.


.. cssclass:: properties morse-section

Configuration parameters for Radar Altimeter
--------------------------------------------


You can set these properties in your scripts with ``<component>.properties(<property1>=..., <property2>=...)``.

- ``MaxRange`` (float, default: ``30.0``)
	Maximum distance to which ground is detected.If nothing is detected, return +infinity


.. cssclass:: fields morse-section

Data fields
-----------


This sensor exports these datafields at each simulation step:

- ``timestamp`` (float, initial value: ``0.0``)
	number of seconds in simulated time
- ``z`` (float, initial value: ``0.0``)
	Distance to "ground"

*Interface support:*

- :tag:`socket`  as straight JSON serialization (:py:mod:`morse.middleware.socket_datastream.SocketPublisher`)
- :tag:`text`  as key = value format with timestamp and index value (:py:mod:`morse.middleware.text_datastream.Publisher`)
- :tag:`yarp`  as yarp::Bottle (:py:mod:`morse.middleware.yarp_datastream.YarpPublisher`)


.. cssclass:: services morse-section

Services for Radar Altimeter
----------------------------

- ``set_property(prop_name, prop_val)`` (blocking)
    Modify one property on a component
    
    
  - Parameters

    - ``prop_name``: the name of the property to modify (as shown the documentation)
    - ``prop_val``: the new value of the property. Note that there is no checking about the type of the value so be careful

  - Return value

    nothing 

- ``get_properties()`` (blocking)
    Returns the properties of a component.
    
    
  - Return value

    a dictionary of the current component's properties  

- ``get_local_data()`` (blocking)
    Returns the current data stored in the sensor.
    
    
  - Return value

    a dictionary of the current sensor's data 

- ``get_configurations()`` (blocking)
    Returns the configurations of a component (parsed from the properties).
    
    
  - Return value

    a dictionary of the current component's configurations  



.. cssclass:: examples morse-section

Examples
--------


The following examples show how to use this component in a *Builder* script:

.. code-block:: python


    from morse.builder import *
    
    # adds a default robot (the MORSE mascott!)
    robot = Morsy()
    
    # creates a new instance of the sensor
    radaraltimeter = RadarAltimeter()

    # place your component at the correct location
    radaraltimeter.translate(<x>, <y>, <z>)
    radaraltimeter.rotate(<rx>, <ry>, <rz>)
    
    robot.append(radaraltimeter)
    
    # define one or several communication interface, like 'socket'
    radaraltimeter.add_interface(<interface>)

    env = Environment('empty')
    

.. cssclass:: files morse-section

Other sources of examples
+++++++++++++++++++++++++

- `Source code <../../_modules/morse/sensors/radar_altimeter.html>`_
- `Unit-test <../../_modules/base/radar_altimeter_testing.html>`_




*(This page has been auto-generated from MORSE module morse.sensors.radar_altimeter.)*
