org.youscope.addon.celldetection.utils

Class MatlabFunctionCreator

java.lang.Object

org.youscope.addon.celldetection.utils.MatlabFunctionCreator

public class MatlabFunctionCreator
extends java.lang.Object

Function converting a Matlab script file stored as a resource inside a jar file into a function, and stores this function as a temporary file such that it can be called normally.

Author:

Moritz Lang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_BASE_NAME Base name of all temporary files created.
static java.lang.String	FILE_EXTENSION File extension of all temporary files created.

Constructor Summary

Constructors

Constructor and Description
MatlabFunctionCreator(java.lang.String resourcePath, java.lang.String... arguments) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCDString() Returns the command for Matlab to switch its current directory to the temporary directory.
java.lang.String	getFullInvokeString() Returns a string with which the Matlab function can be called.
java.lang.String	getFunctionCallString() Returns a string with which the Matlab function can be called.
java.lang.String	getFunctionName() Returns the name of the function created.
java.lang.String	getFunctionPath() Returns the path to the temporary directory where the created Matlab function is stored.
void	initialize() Creates the Matlab temporary function file.
void	uninitialize() Deletes the temporary Matlab string, if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_BASE_NAME

public static final java.lang.String FILE_BASE_NAME

Base name of all temporary files created.

See Also:

Constant Field Values

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

File extension of all temporary files created.

See Also:

Constant Field Values

Constructor Detail

MatlabFunctionCreator

public MatlabFunctionCreator(java.lang.String resourcePath,
                             java.lang.String... arguments)

Constructor.

Parameters:

resourcePath - The resource path to the Matlab script in a jar file.

arguments - The arguments the Matlab function takes. Typically, the same as the names of the variables provided to Matlab.

Method Detail

getFunctionName

public java.lang.String getFunctionName()

Returns the name of the function created. Same as the file name, without extension.

Returns:

Matlab function name.

getFunctionPath

public java.lang.String getFunctionPath()

Returns the path to the temporary directory where the created Matlab function is stored.

Returns:

Path to temporary directory.

getFunctionCallString

public java.lang.String getFunctionCallString()

Returns a string with which the Matlab function can be called. Variables with the same name as the function's argument must have already be passed to Matlab. Furthermore, Matlab has to be at the temporary directory.

Returns:

Function invocation string.

getCDString

public java.lang.String getCDString()

Returns the command for Matlab to switch its current directory to the temporary directory.

Returns:

Directory change string.

getFullInvokeString

public java.lang.String getFullInvokeString()

Returns a string with which the Matlab function can be called. Variables with the same name as the function's argument must have already be passed to Matlab. The directory is automatically set to the temporary directory. Combination of getCDString() and getFunctionCallString().

Returns:

Full Matlab function invocation string.

initialize

public void initialize()
                throws ResourceException

Creates the Matlab temporary function file.

Throws:

ResourceException - Thrown if file could not be created.

uninitialize

public void uninitialize()
                  throws ResourceException

Deletes the temporary Matlab string, if necessary.

Throws:

ResourceException - Thrown if file could not be deleted.