Click or drag to resize

RelaxISPlugin_MultifitModel Class

This plugin type implements a fitting model with more independent variables than just the frequency. Additionally, metadata values like the temperature can be used in the model, allowing fitting of multiple spectra at once. Two sets of parameters are used: - Shared parameters: Intended to be used simultaneously for each spectrum - Individual parameters: Intended to be uniquely used by single spectra. A set of these parameters are generated for each spectrum. When individual parameters are to be used in the FitFunction(Double, Double), the correct index in the Parameter array can be found using GetIndividualParameterIndex(Int32, Int32, Int32, Int32) if all spectra returned the same number of individual parameters.
Inheritance Hierarchy
SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      RelaxIS_SDK.PluginsRelaxISPlugin_MultifitModel

Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.24.6
Syntax
Copy
public abstract class RelaxISPlugin_MultifitModel : RelaxISOnlyPlugin

The RelaxISPlugin_MultifitModel type exposes the following members.

Constructors
 NameDescription
Protected methodRelaxISPlugin_MultifitModelInitializes a new instance of the RelaxISPlugin_MultifitModel class
Top
Properties
 NameDescription
Public propertyDescription A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin)
Public propertyDisplayName Defines the name that is displayed in the list of multi fit plugins in the RelaxIS dialog.
Public propertyName The plugins's internal name, that is used to reference it on various occasions
(Inherited from RelaxISPlugin)
Public propertyParameterStartIndizes Gets the dictionary of start indizes for each spectrum by index.
Public propertyPluginSourcePath Gets or sets the full path of the file that the plugin was loaded from.
(Inherited from RelaxISPlugin)
Protected propertyRelaxISProgramInterface Gets an instance of the RelaxIS Program interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin)
Protected propertyRelaxISWCFInterface Gets an instance of the WCF interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin)
Public propertyRequiredMetadata Defines the names of the metadata values, which will be included as independent parameters
Public propertySortIndex 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)
Public propertyTransferFunction The transfer function name that the fit should be performed in, e.g. Impedance
Public propertyUserDataDirectory Gets or sets the path to the RelaxIS user data directory.
(Inherited from RelaxISPlugin)
Top
Methods
 NameDescription
Protected methodAddLogMessage(Exception) Advises RelaxIS to add information about the given exception to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin)
Protected methodAddLogMessage(String) Advises RelaxIS to add a new message to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin)
Public methodAfterInitialization This method is called once after the parameter initialization was performed by the user but before the fit is executed. Use this method to e.g. check or save initial parameters.
Public methodAfterStartupInitialization Is called once after the plugin is initialized with all internal information during program start.
(Inherited from RelaxISPlugin)
Public methodCompareTo Compares the plugin to another based on the SortIndex property
(Inherited from RelaxISPlugin)
Public methodFitFunction The actual model function used for fitting.
Public methodForFit This function is used in the actual fitting algorithm and is of no concern for plugin generation
Public methodGetAdditionalEvaluations Allows the calculation of derived values from the fit results for each fitted spectrum
Public methodGetAdditionalInformation Provides additional information about this plugin, like e.g. the unit of a transfer function.
(Inherited from RelaxISPlugin)
Protected methodGetIndividualParameterIndex Calculates the index of the i's individual parameter in the full parameter list
Public methodGetIndividualParameters Allows setting up the individual parameter sets per spectrum, in addition to the shared parameters from GetSharedParameters(ListImpedanceSpectrum)
Public methodGetSharedParameters Allows setting up the shared parameters for the selected list of spectra.
Public methodInternalSetProgramInstance Set the internal program instance to a new value.
(Inherited from RelaxISOnlyPlugin)
Public methodInternalSetWCFInstance Set the internal wcf instance to a new value.
(Inherited from RelaxISOnlyPlugin)
Public methodPerformSetup This method is called once before the parameter initialization is started, right after the model was selected by the user. Use this method to perform initializations or for user interaction.
Public methodShouldDiscardPlugin 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)
Top
See Also