Difference: DpHipeTools (3 vs. 4)

Revision 42008-01-15 - JorgoBakker

Line: 1 to 1
 
META TOPICPARENT name="DpHipe"

Adding Tools to HIPE

Line: 21 to 21
 

Task Registry

Changed:
<
<
>
>
 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.:
    # __init__.py file

Line: 51 to 51
  } }
Added:
>
>
 

Prime input validation

Added:
>
>
 The mechanism above makes you task to become a tool within the system and it appears whenever a variable of type SpecificProduct is selected.

Sometimes this may not be enough, e.g. is 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 ObservationContext: such a task should not be listed whenever a HIFI observation is selected...

Line: 73 to 75
 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 HIPE that can be ran against specific data.
Added:
>
>
 

Task Input Dialog

Added:
>
>
 Default dialog, drag-and-drop features, dedicated dialogs The application is generating 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.
Line: 115 to 119
 

Note that your GUI component must have a default constructor!

Added:
>
>
 

Parameter Modifiers

Added:
>
>
 TODO: Default modifiers, specialized modifiers
Added:
>
>
 

Task compliance

Added:
>
>
 
  • 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.
Added:
>
>
 
Changed:
<
<
-- JorgoBakker - 21 Dec 2007
>
>
<-- Author: JorgoBakker - 21 Dec 2007 -->
 
META FILEATTACHMENT attachment="hipe-tools.jpg" attr="h" comment="Task, tools and variables" date="1198422542" name="hipe-tools.jpg" path="hipe-tools.jpg" size="13675" stream="hipe-tools.jpg" user="Main.JorgoBakker" version="1"
 
This site is powered by the TWiki collaboration platform Powered by Perl