Changes between Version 11 and Version 12 of PluginMenu

Timestamp:

Mar 8, 2013, 12:01:03 PM (12 years ago)

Author:

marie

Comment:

--

PluginMenu

@@ -8 +8 @@
 '''Writing Batchable and Plugin classes'''
 
-MorphAnalyser handles two plugin interfaces. The first, Batchable3D, allows single and batch processing of 3D images. A no-args constructor (or no constructor for the no args default) needs to be provided for loading at runtime (using java reflection). Most of the work should be done in the process method, which will be used to process each ObjectGeometry (as listed in a standard text list file, with one .obj per line). Other methods required include an initialisation method, 3 methods to indicate if the template should be read or written, and if the object geometry should be written.
+MorphAnalyser handles two plugin interfaces. The first, Batchable3D, allows single and batch processing of 3D images. A no-args constructor (or no constructor for the no args default) needs to be provided for loading at runtime (using java reflection). Most of the work should be done in the process method, which will be used to process each ObjectGeometry (as listed in a standard text list file, with one .obj per line). Other methods required include an initialisation method, 3 methods to indicate if the template should be read or written, and if the object geometry should be written.  A finish method is used for any clean up, and a getName method is used to retrieve the name displayed on the menu. A simple example of a Batchable3D that crops to a plane is given below:
+
+{{{
+public class BatchCropPlugin3D implements  Batchable3D {
+   MorphAnalyser2 morphanalyser;
+
+   public boolean process(ObjectGeometry obj, Template3D t3d, boolean single) {
+       float[] plane = morphanalyser.getPlane();
+       obj.trimToPlane2(plane);
+       return true;
+   }
+
+    public boolean initialise(MorphAnalyser2 morphanalyser) {
+        this.morphanalyser = morphanalyser;
+        return true;
+    }
+
+    public void finish() {}
+  
+    public String getName() {return "Crop";}
+
+    public boolean getReadTemplate3D() {return false;}
+
+    public boolean getWriteTemplate3D() {return false;}
+
+    public boolean getWriteObjectGeometry() {return true;}
+
+}
+}}}
 
 The second interface, Plugin3D, is more general, and simply supports a setup and cleanup method.