{% comment %} * Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ * Contact: beat.support@idiap.ch * * This file is part of the beat.web module of the BEAT platform. * * Commercial License Usage * Licensees holding valid commercial BEAT licenses may use this file in * accordance with the terms contained in a written agreement between you * and Idiap. For further information contact tto@idiap.ch * * Alternatively, this file may be used under the terms of the GNU Affero * Public License version 3 as published by the Free Software and appearing * in the file LICENSE.AGPL included in the packaging of this file. * The BEAT platform is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY * or FITNESS FOR A PARTICULAR PURPOSE. * * You should have received a copy of the GNU Affero Public License along * with the BEAT platform. If not, see http://www.gnu.org/licenses/. {% endcomment %} {% load ui_tags %}
{% if object.splittable or object.analysis %}
{% if object.splittable %} This plotter is splittable{% endif %} {% if object.analysis %} This plotter is an analyzer. It can only be used on analysis blocks.{% endif %}
{% endif %} {% with parameters=object.json_parameters uses_and_groups=object.uses_and_groups %} {% with uses_and_groups.0 as uses %} {% with uses_and_groups.1 as groups %} {% if parameters or uses or groups %}
{% if groups %}

Plotters have at least one input and one output. All plotter endpoints are organized in groups. Groups are used by the platform to indicate which inputs and outputs are synchronized together. The first group is automatically synchronized with the channel defined by the block in which the plotter is deployed.

{% for group in groups %}
{% if group.name %}

Group: {{ group.name }}

{% else %}

Unnamed group

{% endif %} {% for name, value in group.inputs.items %} {% endfor %} {% for name, value in group.outputs.items %} {% endfor %}
Endpoint Name Data Format Nature
{{ name }} {% with value.type|split_fullname as parts %}{{ value.type }}{% endwith %} Input
{{ name }} {% with value.type|split_fullname as parts %}{{ value.type }}{% endwith %} Output
{% endfor %}
{% endif %}{# groups #} {% if object.result_dataformat %} {% with object.json_result as result %}

Analyzers may produce any number of results. Once experiments using this analyzer are done, you may display the results or filter experiments using criteria based on them.

{% for name, value in result.items %} {% endfor %}
Name Type
{% if "+" in name %}{{ name|cut:"+" }} {% else %}{{ name }}{% endif %} {% if "/" in value %}{% with value|split_fullname as parts %}{{ value }}{% endwith %}{% else %}{{ value }}{% endif %}
{% endwith %} {% endif %}{# results #} {% if parameters %}

Parameters allow users to change the configuration of an plotter when scheduling an experiment

{% for key, value in parameters.items %} {% endfor %}
Name Description Type Default
{{ key }} {{ value.description }} {{ value.type }} {{ value.default }}
{% endif %}{# parameters #} {% if uses %}

Plotters may use functions and classes declared in libraries. Here you can see the libraries and import names used by this library. You don't need to import the library manually on your code, the platform will do it for you. Just use the object as it has been imported with the selected named. For example, if you choose to import a library using the name lib, then access function f within your code like lib.f().

{% for key, value in uses.items %} {% endfor %}
Library Import as
{% with value|split_fullname as parts %}{{ value }}{% endwith %} {{ key }}
{% endif %}{# libraries "uses" #}
{% endif %}{# groups, uses or parameters #} {% endwith %}{# groups, uses or parameters #} {% endwith %}{# groups, uses or parameters #} {% endwith %}{# groups, uses or parameters #} {% if open_source %}

{{ texts.code|safe }}

{% else %}
This plotter is only usable to you. Its code was not shared.
{% endif %}
{% if owner and object.modifiable %}
Edit
{% endif %}
{% if open_source %} {% endif %}