Relax |
Defines a plugin that classifies a spectrum into a specific class.
Inheritance HierarchySystemObject
RelaxIS_SDK.PluginsRelaxISPlugin
RelaxIS_SDK.PluginsRelaxISOnlyPlugin
RelaxIS_SDK.PluginsRelaxISPlugin_Classifier
RelaxIS_SDK.PluginsRelaxISPlugin
RelaxIS_SDK.PluginsRelaxISOnlyPlugin
RelaxIS_SDK.PluginsRelaxISPlugin_Classifier
Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.24.6
SyntaxThe RelaxISPlugin_Classifier type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RelaxISPlugin_Classifier | Initializes a new instance of the RelaxISPlugin_Classifier class. |
Properties| Name | Description | |
|---|---|---|
 | Description |
A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin) |
| DisplayName | Gets a string that is used to display the plugin name. |
| Name |
The plugins's internal name, that is used to reference it on various occasions
(Inherited from RelaxISPlugin) |
| OptimizerType | Gets the type of optimization that this classifier performs. |
| PluginSourcePath |
Gets or sets the full path of the file that the plugin was loaded from.
(Inherited from RelaxISPlugin) |
 | 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) |
| SupportApplyResult | Gets a value indicating if the ApplyClassResultAsync(ImpedanceSpectrum, ExecutionMode, ClassResult, ClassificationResult, CancellationToken) can be called for the plugin. |
| SupportsSelectableClasses | Gets a value indicating whether the classifier supports the user selecting a subset of the classes returned by GetClasses(ExecutionMode, ClassifierClassSettingsBase). |
| UserDataDirectory |
Gets or sets the path to the RelaxIS user data directory.
(Inherited from RelaxISPlugin) |
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) |
| ApplyClassResultAsync | Apply a specific class result to the spectrum. |
| CompareTo |
Compares the plugin to another based on the SortIndex property
(Inherited from RelaxISPlugin) |
| GetAdditionalInformation |
Provides additional information about this plugin, like e.g. the unit of a transfer function.
(Inherited from RelaxISPlugin) |
| GetClasses | Get a list of available classes that the classifier can select for a spectrum. |
| GetFactory | Create a factory object to generate required objects for this classifier. |
| 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) |
| OnClassifierProgress | Raises the ClassifierProgress event. |
| RunClassificationAsync | Classify the given spectrum. |
| 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) |
| UpdateProgress | Raise the ClassifierProgress with the given information. |
Events| Name | Description | |
|---|---|---|
 | ClassifierProgress | Raised when the classifier made progress. |
Remarks
RelaxIS will do the steps in the follwing order:
1. Call GetFactory to create an IClassifierObjectFactory.
2. Call CreateClassSettings(ExecutionMode) create a ClassifierClassSettingsBase.
3. Call CreateClassSettingsControl to create a setup control for it
4. Call InitializeFrom(ClassifierClassSettingsBase) with the class settings object.
5. Call ApplyTo(ClassifierClassSettingsBase) with the user-defined options on the control.
6. Call GetClasses(ExecutionMode, ClassifierClassSettingsBase) with the options.
7. Call CreateSettings(ExecutionMode) create a ClassifierSettingsBase.
8. Call CreateClassSettingsControl create a ClassifierSettingsControlBase.
9. Call InitializeFrom(ClassifierSettingsBase) with the settings object.
10. Call ApplyTo(ClassifierSettingsBase) with the user-defined options on the control.
11. Call RunClassificationAsync(ImpedanceSpectrum, ExecutionMode, ClassifierSettingsBase, ClassifierClassCollection, CancellationToken).
12. Call ApplyClassResultAsync(ImpedanceSpectrum, ExecutionMode, ClassResult, ClassificationResult, CancellationToken) with the
See Also