RelaxISPlugin_ResultEvaluator Class

This defines a Result-Evaluation fitting function, used to further evaluate the fit results from RelaxIS.

Inheritance Hierarchy

SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      RelaxIS_SDK.PluginsRelaxISPlugin_ResultEvaluator

Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63

Syntax

Copy

public abstract class RelaxISPlugin_ResultEvaluator : RelaxISOnlyPlugin

Public MustInherit Class RelaxISPlugin_ResultEvaluator
	Inherits RelaxISOnlyPlugin

Dim instance As RelaxISPlugin_ResultEvaluator

The RelaxISPlugin_ResultEvaluator type exposes the following members.

Constructors

	Name	Description
	RelaxISPlugin_ResultEvaluator	Initializes a new instance of the RelaxISPlugin_ResultEvaluator class

Top

Properties

	Name	Description
	Description	A short description of what the plugin does. Displayed on various occasions for clarification (Inherited from RelaxISPlugin)
	Formula	The formula used to fit data FOR DISPLAY PURPOSES ONLY!
	FunctionGroup	This determines the subgroup in the UI, that the function is stored in
	IsDescriptiveStatistic	If set to true, the evaluator will not be used for fitting. You should override GetDescriptiveStatistics(Double, Double) if you set this to true
	Name	The plugins's internal name, that is used to reference it on various occasions (Inherited from RelaxISPlugin)
	PluginSourcePath	Gets or sets the full path of the file that the plugin was loaded from. (Inherited from RelaxISPlugin)
	PreTransformXDescription	A description (usually a formula) of the transformation being applied to all X-values by the PreTransformXValue(Double) before the fit. Will be used to change the plot axes automatically, so use the placeholder ValuePlaceholder in the formula.
	PreTransformYDescription	A description (usually a formula) of the transformation being applied to all Y-values by the PreTransformYValue(Double) before the fit. Will be used to change the plot axes automatically, so use the placeholder ValuePlaceholder in the formula.
	RelaxISProgramInterface	Gets an instance of the RelaxIS Program interface for the RelaxIS instance that the plugin is loaded in. (Inherited from RelaxISOnlyPlugin)
	RelaxISWCFInterface	Gets an instance of the WCF interface for the RelaxIS instance that the plugin is loaded in. (Inherited from RelaxISOnlyPlugin)
	SortIndex	By default the plugins are sorted based on the value of this property. That means, that they appear in lists in the order dictated by this value. (Inherited from RelaxISPlugin)
	UserDataDirectory	Gets or sets the path to the RelaxIS user data directory. (Inherited from RelaxISPlugin)

Top

Methods

	Name	Description
	AddLogMessage(Exception)	Advises RelaxIS to add information about the given exception to the log. Will not work in the object's constructor. (Inherited from RelaxISPlugin)
	AddLogMessage(String)	Advises RelaxIS to add a new message to the log. Will not work in the object's constructor. (Inherited from RelaxISPlugin)
	AfterStartupInitialization	Is called once after the plugin is initialized with all internal information during program start. (Inherited from RelaxISPlugin)
	CompareTo	Compares the plugin to another based on the SortIndex property (Inherited from RelaxISPlugin)
	FitFunction	Conversion to the internal fitting function interface.
	GetAdditionalInformation	Returns additional Name/Value pairs that further describe this specific plugin (Overrides RelaxISPluginGetAdditionalInformation)
	GetDescriptiveStatistics	Calculates descriptive statistics for the given data
	GetFurtherEvaluations	This allows the calculation and further evaluation of the fitting results, e.g. calculation of the Activation energy from an Arrhenius fit.
	GetInitialFixedStates	This function can designate which parameters are fixed by default. The returned array should have the same length as the number of parameters.
	GetInitialValues	This function needs to calculate initial starting parameters for the given X- and Y-Values.
	GetParameterNames	Should return a list of parameter names.
	InternalSetProgramInstance	Set the internal program instance to a new value. (Inherited from RelaxISOnlyPlugin)
	InternalSetWCFInstance	Set the internal wcf instance to a new value. (Inherited from RelaxISOnlyPlugin)
	PreTransformXValue	The pre-transformation is applied to the x-data coming from the result preview plot. E.g. the XYFunction(Double, Double) will only see the transformed values as the X-Parameter
	PreTransformYError	The pre-transformation is applied to the y-error-data coming from the result preview plot. This should be the correct error-propagation formula for the PreTransformYValue(Double) transformation you apply
	PreTransformYValue	The pre-transformation is applied to the y-data coming from the result preview plot. E.g. the XYFunction(Double, Double) should also output the transformed value as Y. You should also override PreTransformYError(Double, Double)!
	ShouldDiscardPlugin	Called once after the plugin is initialized and after AfterStartupInitialization and signals to RelaxIS if the plugin should be used or discarded. (Inherited from RelaxISPlugin)
	StartEvaluator	This method is called when the evaluator is selected in RelaxIS before the parameter auto-initialization.
	XYFunction	Defines the fitting function, that is used to fit the result-preview graph

Top

Fields

	Name	Description
	NoTransform	Defines the string that means, that no pretransformation of the data is performed by this plugin
	ValuePlaceholder	The placeholder used in the transformation descriptions, which will be replaced by e.g. the axis values

Top

Reference

RelaxIS_SDK.Plugins Namespace

Other Resources

Result Evaluator Example

RelaxISPlugin General Example

RelaxISOnlyPlugin General Example