Facemorph.psychomorph
Interface Batchable

All Known Implementing Classes:
Average, BatchCategoriseImage, BatchChimericTransform, BatchColourCalibrate, BatchCorrectMouth, BatchCorrectTemplate, BatchExtraPoints, BatchMRFTransform, BatchSymmetrise

public interface Batchable

Batchable interface, this should be implemented by classes that wish to be loaded as Psychomorph plugins. You should aslo supply a no-args constructor (or no constructor for the no args default) for loading at runtime (using java reflection)


Method Summary
 void finish()
          Performs any processing required at the end of the batch loading,
 java.lang.String getName()
          Gets the name of the Batchable, used in to put them on the psychomorph menu in the form (for "My Bachable"): - My Batchable - Batch My Batchable
 boolean getReadTemplate()
          Indicates if templates should be read in during batch operation
 boolean getWriteImage()
          Indicates if images should be written out during batch operation
 boolean getWriteTemplate()
          Indicates if templates should be written out during batch operation
 boolean initialise(PsychoMorphForm psychomorph)
          Initialise the Batchable This is called each time the batchable is selected
 boolean process(ImageZoomPanel izp, boolean single)
          The process method is called for each image in the list, or for the current image in single mode
 

Method Detail

process

boolean process(ImageZoomPanel izp,
                boolean single)
The process method is called for each image in the list, or for the current image in single mode

Parameters:
izp - The ImageZoomPanel holds the image and Template to process
single - this indicates that we are (or are not) in bacth mode. Useful for things like saving undo data (for single) or not (for batch)
Returns:
returns true if the processing was successfule, or false if not

initialise

boolean initialise(PsychoMorphForm psychomorph)
Initialise the Batchable This is called each time the batchable is selected

Parameters:
psychomorph - the main psychomorph object
Returns:
returns true if initialised OK

finish

void finish()
Performs any processing required at the end of the batch loading,


getName

java.lang.String getName()
Gets the name of the Batchable, used in to put them on the psychomorph menu in the form (for "My Bachable"): - My Batchable - Batch My Batchable

Returns:
return the name of your Batchable aas a String

getReadTemplate

boolean getReadTemplate()
Indicates if templates should be read in during batch operation

Returns:
return true if the template should be read

getWriteTemplate

boolean getWriteTemplate()
Indicates if templates should be written out during batch operation

Returns:
return true if the template should be written

getWriteImage

boolean getWriteImage()
Indicates if images should be written out during batch operation

Returns:
return true if the image should be written