Algorithm type
This document describes the properties of the JSON API object. You also can access the document in JSON Schema format: algorithm.schema.json
Defines a new node type
- id: string
-
Unique algorithm ID
- metadata: See metadata
-
General algorithm metadata
- category: string org.hkijena.jipipe:miscellaneous
-
The category
- exported-parameters: object [object Object]
-
List of parameters that will be exported to users of the node
- graph: See graph
-
This graph is executed when the algorithm is run
- menu-path: string
-
Optional menu path within the category menu
- jipipe:project-type: string , x ∈ { graph-wrapper-algorithm (default) }
-
Identifies the JSON as algorithm
Example
{
"id" : "folder-list-tif",
"metadata" : {
"name" : "List TIFF files",
"description" : "Lists all TIFF files in a folder",
"authors" : "Ruman Gerst",
"website" : "",
"license" : "BSD-2",
"citation" : ""
},
"category" : "Converter",
"parameter-visibilities" : {
"visible-keys" : [ ]
},
"graph" : {
"nodes" : {
"default-preprocessing-filter-files" : {
"jipipe:slot-configuration" : {
"Files" : {
"slot-data-type" : "file",
"slot-type" : "Input",
"inherited-slot" : null,
"name" : "Files",
"custom-name" : null,
"inheritance-conversions" : { }
},
"Filtered files" : {
"slot-data-type" : "file",
"slot-type" : "Output",
"inherited-slot" : null,
"name" : "Filtered files",
"custom-name" : null,
"inheritance-conversions" : { }
}
},
"jipipe:algorithm-ui-location" : {
"{Vertical}" : {
"x" : 25,
"y" : 250
}
},
"jipipe:algorithm-type" : "file-filter",
"jipipe:algorithm-compartment" : "DEFAULT",
"name" : "Filter *.tif",
"description" : null,
"filters" : [ {
"mode" : "Glob",
"filterString" : "*.tif"
} ],
"jipipe:trait-generation" : {
"modification" : {
"per-slot" : { },
"global" : { }
},
"transfer" : {
"transfers" : [ ],
"transfer-all-to-all" : true
}
},
"jipipe:dynamic-parameters" : { }
},
"default-preprocessing-list-files" : {
"jipipe:slot-configuration" : {
"Folders" : {
"slot-data-type" : "folder",
"slot-type" : "Input",
"inherited-slot" : null,
"name" : "Folders",
"custom-name" : null,
"inheritance-conversions" : { }
},
"Files" : {
"slot-data-type" : "file",
"slot-type" : "Output",
"inherited-slot" : null,
"name" : "Files",
"custom-name" : null,
"inheritance-conversions" : { }
}
},
"jipipe:algorithm-ui-location" : {
"{Vertical}" : {
"x" : 25,
"y" : 50
}
},
"jipipe:algorithm-type" : "folder-list-files",
"jipipe:algorithm-compartment" : "DEFAULT",
"name" : "List files",
"description" : null,
"jipipe:trait-generation" : {
"modification" : {
"per-slot" : { },
"global" : { }
},
"transfer" : {
"transfers" : [ ],
"transfer-all-to-all" : true
}
},
"jipipe:dynamic-parameters" : { }
}
},
"edges" : [ {
"source-algorithm" : "default-preprocessing-list-files",
"target-algorithm" : "default-preprocessing-filter-files",
"source-slot" : "Files",
"target-slot" : "Files"
} ]
},
"menu-path" : "",
"jipipe:project-type" : "graph-wrapper-algorithm",
"preferred-traits" : [ ],
"unwanted-traits" : [ ],
"added-traits" : [ ],
"removed-traits" : [ ]
}