sbrt.kernel.fba.proc
Class CvFbaOptimizationExperiment

java.lang.Object
  extended by sbrt.kernel.fba.proc.FbaProcess<FbaOptComputer.Results>
      extended by sbrt.kernel.fba.proc.CvFbaOptimizationExperiment
All Implemented Interfaces:
KernelProcess<FbaOptComputer.Results>, MonitoredProcess<FbaOptComputer.Results>

public final class CvFbaOptimizationExperiment
extends FbaProcess<FbaOptComputer.Results>
implements MonitoredProcess<FbaOptComputer.Results>

This class is used to perform constraint-variation FBA optimization experiments.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Constructor Summary
CvFbaOptimizationExperiment(FbaOptComputer computer)
          Constructs a new constraint-variation FBA optimization experiment.
 
Method Summary
 Fluxome getFluxome()
          Returns the fluxome used in this experiment.
 MathExpr<java.lang.String> getObjectiveFunction()
          Returns the current objective function.
 OptimizationSense getOptimizationSense()
          Returns the current optimization sense.
 ProgressMonitor getProgress()
          Returns a progress monitor for this experiment.
 void run(ResultsManager<FbaOptComputer.Results> resultsManager)
          Runs this process and adds the generated results to the provided results manager via its ResultsManager.addData(Object) method.
 void setConstraintSource(java.lang.Iterable<FluxConstraints> constraintSource)
          Sets the constraint variation input source.
 void setObjectiveFunction(MathExpr<java.lang.String> objective)
          Sets the objective function to the provided mathematical expression.
 void setOptimizationSense(OptimizationSense sense)
          Sets the optimization sense to the provided value.
 
Methods inherited from class sbrt.kernel.fba.proc.FbaProcess
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CvFbaOptimizationExperiment

public CvFbaOptimizationExperiment(FbaOptComputer computer)
Constructs a new constraint-variation FBA optimization experiment.

Parameters:
computer - the computer with which all results will be computed.
Method Detail

getFluxome

public Fluxome getFluxome()
Returns the fluxome used in this experiment.

Specified by:
getFluxome in class FbaProcess<FbaOptComputer.Results>
Returns:
the fluxome used in this experiment.

getObjectiveFunction

public MathExpr<java.lang.String> getObjectiveFunction()
Returns the current objective function.

Returns:
the current objective function.

getOptimizationSense

public OptimizationSense getOptimizationSense()
Returns the current optimization sense.

Returns:
the current optimization sense.

setObjectiveFunction

public void setObjectiveFunction(MathExpr<java.lang.String> objective)
Sets the objective function to the provided mathematical expression.

Parameters:
objective - a mathematical expression of reaction names.

setOptimizationSense

public void setOptimizationSense(OptimizationSense sense)
Sets the optimization sense to the provided value.

Parameters:
sense - an optimization sense.

setConstraintSource

public void setConstraintSource(java.lang.Iterable<FluxConstraints> constraintSource)
Sets the constraint variation input source.

Parameters:
constraintSource - a source of constraint sets whose effect upon application is to be computed.

getProgress

public ProgressMonitor getProgress()
Returns a progress monitor for this experiment.

Specified by:
getProgress in interface MonitoredProcess<FbaOptComputer.Results>
Returns:
a progress monitor for this experiment.

run

public void run(ResultsManager<FbaOptComputer.Results> resultsManager)
Runs this process and adds the generated results to the provided results manager via its ResultsManager.addData(Object) method.

A set of flux constraints is retrieved from the constraint source, their effect is computed, and the results are added to the provided results manager. This is repeated until the end of the deletion source is reached.

Specified by:
run in interface KernelProcess<FbaOptComputer.Results>
Parameters:
resultsManager - the results manager to which the results will be added.