(r51) DpHipeTools < Public

Public Web>DpHipe>DpHipeTools (revision 51) (raw view)~~EditAttach~~
---+ !!Adding Tools to HIPE

%STARTSECTION{"contrGuide_1"}%

<!--
   Some short-cuts
   * Set REGISTRY   = [[DpHipeRegistry][Extension Registry]]
   * Set TOOL         = [[HcssDoc:api/herschel/ia/gui/kernel/Tool.html][Tool]]
   * Set ABSTRACT_TOOL= [[HcssDoc:api/herschel/ia/gui/kernel/AbstractTool.html][AbstractTool]]
   * Set CATEGORY = [[HcssDoc:api/herschel/ia/gui/kernel/Tool.Category.html][Category]]
-->

<img src="%ATTACHURLPATH%/tasks.png" align="RIGHT" alt="Task, tools and variables" width='271' height='404' />

<!-- summary -->
Tools are processing units that operate on specific data elements.%BR%
From the Java point of view, a tool is an implementation of the %TOOL% interface.%BR%
The well-known Tasks are examples of tools within [[DpHipe][HIPE]]. In this case, [[HcssDoc:api/herschel/ia/task/views/TaskTool.html][TaskTool]] is used under the hoods.

If a data element is selected, a list of tools that can operate on that data should appear.
Double clicking on the tool will open an associated view (for non-task tools) or a dialog for settings parameters (for task tools).

%STARTINCLUDE%
This section explains:
   * how you can create a Tool and register it for being available for dedicated data
   * how you can make [[DpHipe][HIPE]] aware of an existing Task,
   * how your task can react better on an active data element,
   * the default task dialog and how you implement and contribute a dedicated input dialog for your task,
   * how you can implement and contribute a specific parameter editor
%STOPINCLUDE%

%ENDSECTION{"contrGuide_1"}%

%TOC%

<br clear="all"/>

%STARTSECTION{"contrGuide_2"}%

---++ Adding a Tool as a Task

---+++ Task Registry
<blockquote>
Up to now you have made you task globally available to the system by specifying an instance of that task within the ==__init__.py== file of your sub-system, e.g.:
<pre>
    # __init__.py file
    compute = ComputeTask()
</pre>

To make your task appear in the "Tasks" view, you need to add the following lines:
<pre>
    from herschel.ia.task.views import TaskToolRegistry
    toolRegistry = TaskToolRegistry.getInstance()
    <b>toolRegistry.register(compute)</b>
</pre>

For PACS users, this ==__init__.py== file is located at $install_dir/data/toolbox/your_sub_system.

You can also specify that your task belongs to one or more %CATEGORY% :
<pre>
    from herschel.ia.gui.kernel.Tool import Category
    toolRegistry.register(compute, <b>[Category.IMAGE, Category.PACS]</b>))
</pre>
Your task will now be enabled whenever a session variable is selected which matches the type of the *first* input parameter within your task!

Within your task, you can control which parameter signs-up to be the prime parameter (the one which reacts on a selected data variable) by the Task API:
<pre>
    class ComputeTask extends Task {
       ComputeTask() {
          super("compute");
          prime = new TaskParameter("spectrum", SpecificProduct.class)
          :
          getSignature().<b>setPrimeInput(prime)</b>
       }
    }
</pre>

Naming conventions for task when to be registered in Hipe should follow this example assuming that the task will perform the functionality named "reduce" :
<pre>
     Name of the Class              : ReduceTask
     Name of the Task (getName())   : reduce
     Name of the variable in Jython : reduce
 </pre>

%ICON{"warning"}% For naming tasks we follow the Java conventions, we use camel-case , not underscores : "reduceLight" is valid, "reduce_light" is not. Info log messages are produced for invalid task names. 
</blockquote>

---+++ Prime input validation
<blockquote>
The mechanism above makes you task to become a tool within the system and it appears whenever a variable of type ==SpecificProduct== (i.e. the type of the value of the Parameter) is selected.

Sometimes this may not be enough, e.g. in certain situations your task will only run on a ==SpecificProduct== if it contains certain _contents_. A typical situation would be when a SPIRE reduction operates on a Hcss.ObservationContext: such a task should not be listed whenever a HIFI observation is selected...

You can write a ==ParameterValidator== to do just that:
<pre>
    prime = new TaskParameter("spectrum", SpecificProduct.class)
    prime.setParameterValidator(new ParameterValidatorAdapter() {
        public void validate(Object value) throws ParameterValidationException {
            SpecificProduct s = (SpecificProduct)value;
            if (! (logic that would validate the contents of the value...)) {
                throw new ParameterValidationException(reason);
            }
        }
    });
</pre>

In other words, rather than writing this logic within the pre-amble or execution block of your task, we recommend you to move that logic into the parameter validation. This way we achieve two things:
   * make the logic appear where it should be and therefore keeping the execution block of your task concentrated to the _algorithm_, and
   * make your task appear as a _tool_ within [[DpHipe][HIPE]] that can be ran against _specific_ data.
</blockquote>

---+++ Task Dialogs

---++++ Default Task Dialog

<blockquote>

The system generates a default input dialog for all registered tasks within the software. As the system does not know the intent of your task, it can only provide a dry-listing of all requested parameters; such a dialog may not be suitable for your purposes.

  The default dialog for the crop task: <br />
     <img src="%ATTACHURLPATH%/crop.png" alt="crop.png" width='509' height='474' />

As for instance you may want to have more control over how the input parameters are presented to the user:
   * you may only want to provide a sub-set of parameters (and leave the full-set to expert users on the command-line)
   * you may want to organize your parameters by grouping them in tabs, or putting a border around a group of parameters
   * you may want to have more informative tooltips, labels or even input fields that are more suitable for your task.

%ICON{"warning"}% A new default dialog layout has been implemented following the request of the DPUG:
It puts two parameters per line: lines are filled left to right, and then top to bottom. If you only have 1 input (or output) it will fill the whole line. 
Modifiers implementors should take care that the preferred size of their modifier is smaller (about 20 chars max). 
Provided modifiers have been updated but some modifiers are too wide for this layout (ex. AngleModifier, can have 3 texts and 1 combo in a line).

To adapt to these scenarios and more, the system provides three  ways for customizing you Task dialogs:
   * Parameter Modifiers
   * Signature Components
   * Task Panels.

</blockquote>

---++++ Parameter Modifiers
<blockquote>
The system provides a default dialog displaying an input area  for setting the values of the parameter based on a composition of [[HcssDoc:api/herschel/ia/gui/apps/modifier/Modifier.html][Modifiers]].

    The input area for the crop task: <br />
     <img src="%ATTACHURLPATH%/crop_input.png" alt="crop_input.png" width='509' height='474' />

The composition of  [[HcssDoc:api/herschel/ia/gui/apps/modifier/Modifier.html][Modifiers]] is created based on the types of the values of the Task Parameters of the Task Signature.

      The Modifier for the _row1_ Parameter of the crop task: <br />
     <img src="%ATTACHURLPATH%/crop_modifier.png" alt="crop_modifier.png" width='509' height='474' />

Currently the system contains basic implementation for the simple types =Boolean=, =Integer=, =Float=, =Long=, =Double=, =String= and few more, so there's still a lot of space for improvements and contribution. You can find the general available modifiers in package =herschel.ia.gui.apps.modifier=; please consult the Javadoc of your HIPE installation.

If the default parameter doesn't fit for your Task Parameter, you can:
   * Implement a Modifier,
   * Register it to the system.

Alternatively, you could want to write your specific Modifier for one of the already available types. In that case, you could create your modifier in a [[#Implement_a_Task_Signature_Compo][custom Signature Component]].

%ICON{"warning"}% *NOTE:* %BR%
The following behaviours and limitations are present in the provided modifiers:
   * While you can always write =SomeTask(param = null)= in Console, using a task dialog you will get =SomeTask()=: for GUIs "null is not allowed". The task machinery will take nulls as if the parameter has been ignored by the user.
   * Modifiers have no notion of the optionality of parameters: if they have a valid value, they will return it. The task machinery will not generate a parameter assignment if the value equals the default.
   * Specialized modifiers:
      * Will mark as errorenous variables incompatible with the type (dynamically), but will accept any variable.
</blockquote>

----+++++ Implement a Modifier
<blockquote>
 The [[HcssDoc:api/herschel/ia/gui/apps/modifier/Modifier.html][Modifier]] interface consists of two explicit contracts:
   * Support the drag and drop features (the set/getVariableSelection)
   * Support the inspection for Object (the set/getObject)
and two implicit contracts:
   * Be JComponent 
   * If it is registered in the %REGISTRY%, have an empty constructor 
</blockquote> 

----+++++ Register a Modifier
<blockquote>
The registration of the Modifier is done again in the ==__init__.py==  via the %REGISTRY% with the usual syntax (please note the name of the factory: factory.modifier).

Be aware that the registration is system wise so the registration overrides any other registered modifier for that type. 

<pre>
 REGISTRY.register(COMPONENT,Extension(
        "MyModifier",
        "herschel.ia.mymodifier.MyModifier",
        "factory.modifier",
        "herschel.ia.MyClass")
</pre>

In case the Modifier you have created is only applicable to a specific task or even to a specific parameter of a specific task, you can simply assign it to the applicable Task Parameter:

<pre>
    // YourTask constructor
    public YourTask() {
        addTaskParameter(new TaskParameter("someInput", MyClass.class));
        ...
    }

    // Customize your modifiers
    @Override
    public Map&lt;String, Modifier&gt; getCustomModifiers() {
	Map&lt;String, Modifier&gt; map = new LinkedHashMap&lt;String, Modifier&gt;();
	map.put("someInput", new MyModifier());
	return map;
    }
</pre>

%ICON{"warning"}% *NOTE:* %BR%
Using =TaskParameter.setModifier()= for customizing modifiers is _deprecated_.%BR%
This mechanism is unsafe, even dangerous, because it implies executing GUI code at task creation, which is done in a non-GUI thread.%BR%
In consequence, this method is planned to be removed.

</blockquote>

---++++ Signature Components

<blockquote>
In case the default input area based on Modifiers doesn't fit your needs you can just replace it by your own implementation. 

   Rotate Alternative Signature: <br />
     <img src="%ATTACHURLPATH%/rotate.jpg" alt="rotate.jpg" width='361' height='371' />

If this is the case you need to:
   * Implement a Task Signature Component
   * Register it to the system.

----+++++ Implement a Task Signature Component

<blockquote> 
 The [[HcssDoc:api/herschel/ia/task/gui/dialog/TaskSignatureComponent.html][TaskSignatureComponent]] interface consists of four explicit contracts
   * Support the =setVariableSelection= for initial assignment from the Tool Window
   * Assign the Signature to display (=setSignature=)
   * Return a map of parameters and assigned values (in =Map<TaskParameter, !VariableSelection> getParameters=)
   * Clear and check user inputs (used by the default buttons)
and the two implicit contracts inherited by the %REGISTRY%
   * Be JComponent 
   * Have an empty constructor

An easy way of implementing [[HcssDoc:api/herschel/ia/task/gui/dialog/TaskSignatureComponent.html][TaskSignatureComponent]] is by extending [[HcssDoc:api/herschel/ia/task/gui/dialog/JTaskSignatureComponent.html][JTaskSignatureComponent]] and providing your own implementation for the =makeModifierMap()= method.

For example, if you want to use a custom Signature Component that just wants to use [[HcssDoc:api/herschel/ia/gui/apps/modifier/JFilePathModifier.html][JFilePathModifier]] for a parameter aimed for a file name, you could do it like this:

<pre>
public class MySignatureComponent extends JTaskSignatureComponent {

    private static final long serialVersionUID = 1L;

    protected Map&lt;TaskParameter, Modifier&gt; makeModifierMap() {

	SignatureApi signature = getSignature();
	Map&lt;TaskParameter, Modifier&gt; m = new LinkedHashMap&lt;TaskParameter, Modifier&gt;();

	m.put(signature.getTaskParameter("file"), new JFilePathModifier(SAVE));
	m.put(signature.getTaskParameter("number"), new JIntegerModifier());

	return m;
    }
}
</pre>

</blockquote>

----+++++ Register a Task Signature Component

<blockquote> 
 
The registration of the Task Signature Component is done again in the ==__init__.py==  via the %REGISTRY%  with the usual syntax (please note the name of the factory: factory.editor.tool.task.signature).
<pre>
REGISTRY.register(COMPONENT,Extension(
        "Rotate Signature",
        "herschel.ia.task.example.RotateSignatureComponent",
        "factory.editor.tool.task.signature",
        "herschel.ia.image.RotateTask"))
</pre>


 See also the %REGISTRY% documentation for more details.

%ICON{"warning"}% NOTE:
Conventions for labels for input parameters: (see DM).
The static function <pre> public static JLabel getDecoratedLabel(TaskParameter tp, boolean isPrimeInput, String altName) </pre> provides a decorated label (including tooltip) that follows the standard style.

If some other function needs to be made public so that tasks can follow the default style, they will be added above.




</blockquote>


---++++ Custom Task Dialogs
Eventually, if the above options still do not accommodate you needs you can replace the the default Task Panel with your own implementation

If this is the case you need to:
   * Implement a Task Panel 
   * Register it to the system. 

----+++++ Implement a Task Panel 

<blockquote> 
 The [[HcssDoc:api/herschel/ia/task/gui/dialog/TaskPanel.html][TaskPanel]] interface consists of three explicit contracts
   * Support the setVariableSelection for initial assignment from the Tool Window
   * Assign the Task to display ( the setTask)
   * Notify request of executions to the framework  by
      * Allow for setting the Site Event handler for notifying request of execution  (the  setSiteEventHandler method  )
      * Notify the execution requests calling the trigger method of [[HcssDoc:api/herschel/ia/gui/kernel/SiteEventHandler.html][SiteEventHandler]] passing a [[HcssDoc:api/herschel/ia/gui/kernel/event/CommandExecutionRequestEvent.html][CommandExecutionRequestEvent]].%BR%You can create this event through the [[HcssDoc:api/herschel/ia/task/gui/dialog/TaskCommandExecutionEventFactory.html][TaskCommandExecutionEventFactory]].
and the two implicit contracts inherited by the %REGISTRY%
   * Be JComponent 
   * Have an empty constructor
</blockquote>

%ICON{"warning"}% NOTE:
A Task panel will need in the future to provide the actions that invoke "Accept" and "Clear", so that they can be invoked from some other part of the interface (or somebody may remove the Buttons from his panel). Currently we try to invoke the actions via the Toolbar.

   The Rotate Panel example (herschel.ia.task.example.RotatePanel): <br />
     <img src="%ATTACHURLPATH%/rotate_panel.jpg" alt="rotate_panel.jpg" width='323' height='326' />


----+++++ Register a Task Panel 

<blockquote> 
 
The registration of the Task Panel Component is done again in the ==__init__.py==  via the %REGISTRY% with the usual syntax (please note the name of the factory: factory.editor.tool.task.signature).
<pre>
REGISTRY.register(COMPONENT,Extension(
        "Rotate Task Panel",
        "herschel.ia.task.example.RotatePanel",
        "factory.editor.tool.task",
        "herschel.ia.image.RotateTask"));
</pre>


 See also the %REGISTRY% documentation for more details.

</blockquote>

---+++ Task compliance

   * Write user documentation (jtags)! That will be automatically picked up whenever a user asks the system for help on your task.
   * The name of the task should be a legal variable name in the global name-space. For example your instance of ==MyTask== should report itself as e.g.: "myTask" and not  "This is my task".
   * If your prime parameter is not the first parameter in your task, specify the prime parameter using the ==setPrimeInput== method in the signature
   * Write a parameter validator for your prime parameter if your task should be listed not only on prime data type but on prime data contents as well.

---+++ Recommendations for simple tasks and limitations

   * Use a function that fully initializes !TaskParameters: you avoid working with partially initialized data or data with non obvious defaults.
   * Please take care to register your task properly: otherwise it may half-work, which is much worse than not working at all!
   * Capture exceptions and check your params before trying to properly execute, if you want to provide better error reporting than the one provided by default.
   * You should not do user interaction after you have started execute() (not on EDT).
   * Validators: you cannot compare multiple parameters, order of execution is not specified, will be executed several times. So, if you need to validate dependent parameters, it should be done later. 
   * Once you are in execute() console has already been updated with the command : Although you can change the value of !TaskParameters, this will not be properly reflected on the UI, so don't do it. So once you are on execute() you can check , possibly abort, and properly execute (nothing else).


---++ Adding a Tool that is not a Task

If you have an existing task and want to make it available in HIPE, you just need to follow the steps described in the [[#Adding_a_Task_as_a_Tool][above section]].

Now, a task has its limitations. It is somewhat an atomic operation for which you provide some inputs and expect some result.%BR%
Therefore, it is not expected for acting interactively with a user, and it is not meant for holding internal status either, that a user can modify during its execution.

If you need more flexibility, you can write your own implementation of the %TOOL% interface.%BR%
Besides, you would most probably need a viewer associated to your tool, for letting the user interact with it.

This follows in some way the MVC pattern: your target data is the Model, your associated viewer is the View, and your tool is the Controller.

---+++ Tool Implementation
In order to write a tool, %TOOL% interface needs to be implemented. Instead of doing it directly, it is encouraged to extend %ABSTRACT_TOOL%.

The information to be provided is passed to one of its constructors in a ==super== call from the derived class:

<pre>
    /** Constructor for a tool with a single parameter and general category. */
    protected AbstractTool(String name, Parameter primeInput)

    /** Constructor for a tool with a single input parameter. */
    protected AbstractTool(String name, Parameter primeInput, Category... categories)

    /** Constructor for a tool with multiple input parameters and general category. */
    protected AbstractTool(String name, Parameter primeInput, List&lt;? extends Parameter&gt; inputs)

    /** Constructor with all arguments. */
    protected AbstractTool(String name,
                           Parameter primeInput,
                           List&lt;? extends Parameter&gt; inputs,
                           Category... categories)
</pre>
You provide the variable types you are interested in within the prime input: just return a [[HcssDoc:api/herschel/ia/gui/kernel/ToolParameter.html][ToolParameter]] initiated with the proper class of data you want to handle:
<blockquote>
<pre>
new ToolParameter("data", MyTargetDataType.class)
</pre>
</blockquote>

More conditions for checking whether the tool can react on a particular variable can be added by providing a =ParameterValidator= to the prime input.

The actual job to be done can be delegated to a third object (the "tool object"), or just be executed by the tool class itself.%BR%
This latter case is the default, otherwise, you need to call =setToolObject(Object toolObject)= in your constructor.

Moreover, you may return the categories you think the tool is meaningful for, by providing the proper ones in the ==super== call.

---+++ Naming conventions

Conventions for names of a tool class and its variable in the Tasks view are similar than those for tasks. For example, a tool for spectrum filtering could be called:

<pre>
     Name of the Class              : SpectrumFilterTool
     Name of the Tool (getName())   : spectrumFilter
     Name of the variable in Jython : spectrumFilter
 </pre>

---+++ Tool Viewer
Every tool has an associated viewer, which must implement [[HcssDoc:api/herschel/ia/gui/kernel/parts/EditorComponent.html][EditorComponent]] (by extending [[HcssDoc:api/herschel/ia/gui/kernel/parts/AbstractEditorComponent.html][AbstractEditorComponent]] or one of its subclasses).

---+++ Tool Registry
Once you have your tool and the corresponding viewer, you need to register them like this:
<blockquote>
<pre>
# Associate the tool with the viewer
REGISTRY.register(COMPONENT,Extension(
                 "Spectrum Filter Tool",
                 "herschel.path.to.SpectrumFilterToolComponent",
                 "factory.editor.tool",
                 "herschel.path.to.SpectrumFilterTool"))

# Register the tool so it is automatically available for the proper variables in HIPE
from herschel.ia.gui.kernel import ToolRegistry
from herschel.path.to import SpectrumFilterTool
spectrumFilter = SpectrumFilterTool()
ToolRegistry.getInstance().register(spectrumFilter)

__all__ = [ "spectrumFilter", "SpectrumFilterTool", ... ]
</pre>
</blockquote>

---+++ Communicating Tool & Viewer
In the viewer, you can access the tool and the selected data within the =makeEditorContent= method provided by =AbstractEditorComponent=.%BR%
At this point, you can let the tool know about the viewer as well, if you want:
<blockquote>
<pre>
protected boolean makeEditorContent() {

    // Get the tool and the selected data
    ToolSelection selection = getSelection();
    Tool   tool = selection.getTool();
    Object data = selection.getSelection().getValue();

    // Optional - you would need to provide a setViewer method
    ((MyTool)tool).setViewer(this);

    // Build the editor contents ...
}
</pre>
</blockquote>

---+++ Simple sample
This simple reproducible example wraps up the just explained steps altogether.%BR%
It is just a button whose label is changed by the tool when the user clicks on it:

&nbsp;&nbsp;&nbsp;&nbsp;1. *The tool class*
<blockquote>
<pre>
public class SimpleButtonTool extends AbstractTool {

    private ArrayData _data;
    private boolean _flag = true;

    public SimpleButtonTool() {
	super("simpleButton", new ToolParameter("data", ArrayData.class));
    }

    void setData(ArrayData data) {
	_data = data;
    }

    void updateLabel(JButton button) {
	int size = _data.getSize();
	int rank = _data.getRank();
	button.setText("Data has " + (_flag? "size " + size : "rank " + rank));
	_flag = !_flag;
    }
}
</pre>
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp;2. *The viewer class*
<blockquote>
<pre>
public class SimpleButtonToolComponent extends AbstractEditorComponent&lt;ToolSelection&gt; {

    private static final long serialVersionUID = 1L;
    private static int _counter = 1;
    private SimpleButtonTool _tool;

    public SimpleButtonToolComponent() {
	super(new BorderLayout());
    }

    protected Class<ToolSelection> getSelectionType() {
	return ToolSelection.class;
    }

    protected boolean makeEditorContent() {
	final JButton button = new JButton();
	setName("Button Tool " + _counter++);
	_tool = (SimpleButtonTool)getSelection().getTool();
	_tool.setData((ArrayData)getSelection().getSelection().getValue());
	_tool.updateLabel(button);
	button.addActionListener(new ActionListener() {
	    public void actionPerformed(ActionEvent e) {
	        _tool.updateLabel(button);
            }
	});
	add(button);
	return true;
    }

    public Icon getComponentIcon() {
	return IconLibrary.VARIABLE;
    }
}
</pre>
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp;3. *The registration*
<blockquote>
<pre>
COMPONENT = ExtensionRegistry.COMPONENT
REGISTRY  = ExtensionRegistry.getInstance()

REGISTRY.register(COMPONENT,Extension(
                 "Button Tool",
                 "herschel.path.to.SimpleButtonToolComponent",
                 "factory.editor.tool",
                 "herschel.path.to.SimpleButtonTool"))

from herschel.ia.gui.kernel import ToolRegistry
from herschel.path.to import SimpleButtonTool
simpleButton = SimpleButtonTool()
ToolRegistry.getInstance().register(simpleButton)

# cleanup
del(ExtensionRegistry, Extension, REGISTRY, COMPONENT)

__all__ = [ "simpleButton", "SimpleButtonTool" ]
</pre>
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp;4. *Executing the example*
<blockquote>
For executing this simple tool, just include it in a package owned by you, open the workbench in HIPE, and execute the following in the console:
<pre>
x = Int1d.range(12)
y = Double2d([[1,2,3],[4,5,6]])
</pre>
Then open the x and y variables with the Button Tool and click the button: its label is updated by the tool.
</blockquote>

---++ Triggering Events
For a full detailed section about triggering events have a look at DpHipeCommonUtilities.

%ENDSECTION{"contrGuide_2"}%

<!-- Author: Main.JorgoBakker - 21 Dec 2007 -->
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
png	crop.png	r1	manage	13.7 K	2009-09-29 - 15:55	JaimeSaiz
png	crop_input.png	r1	manage	14.5 K	2009-09-29 - 16:09	JaimeSaiz	crop task with input highlighted
png	crop_modifier.png	r1	manage	14.4 K	2009-09-29 - 16:09	JaimeSaiz	crop task with modifier highlighted
png	tasks.png	r1	manage	13.0 K	2009-09-29 - 16:11	JaimeSaiz	Tasks and variables
Topic revision: r51 - 2010-04-29 - DavideRizzo
Public
Webs
Public
TWiki