Function reference

Desirability Classes

utils Utils module for spotdesirability.
utils.desirability
utils.desirability.DesirabilityBase Base class for all desirability functions.
utils.desirability.DMax Implements a desirability function for maximization.
utils.desirability.DMin Implements a desirability function for minimization.
utils.desirability.DTarget Implements a desirability function for target optimization.
utils.desirability.DArb Implements an arbitrary desirability function.
utils.desirability.DBox Implements a box-like desirability function.
utils.desirability.DCategorical Implements a desirability function for categorical inputs.
utils.desirability.DOverall Combines multiple desirability objects into an overall desirability function.

RSM Functions

functions Functions module for spotdesirability.
functions.rsm
functions.rsm.conversion_pred Predicts the percent conversion based on the input vector x.
functions.rsm.activity_pred Predicts the thermal activity based on the input vector x.
functions.rsm.rsm_opt Optimization function to calculate desirability.

Plotting

plot Plot module for spotdesirability.
plot.ccd
plot.ccd.plotCCD Plots a Central Composite Design (CCD) for k=3 with customizable viewpoint.

Data Utilities

data_utils
data_utils.get_data_folder_path Returns the absolute path to the data folder located in the package.
data_utils.load_compressor_data Loads the normalized compressor datasets X and Z.