WeibullDataSet Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(61 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|WeibullDataSet Class|WeibullDataSet}}  
{{Template:API}}{{Template:APIBreadcrumb}}
Provides {{Template:WeibullDataSet Class.Cmt}} <!--Also used in Synthesis_API_Reference-->
{{Template:PlotsNote.Cmt}}


A usage example for this class is available [[WeibullDataSet Class Example|here]].


== Constructors ==
<onlyinclude>Represents a data set for life data analysis. </onlyinclude>
*{{APIName|WeibullDataSet()}} {{APIComment|Initializes a new instance of the WeibullDataSet class with a system-supplied data set name.}}
 
*{{APIName|WeibullDataSet(}} {{APIPrefix|ByVal}}{{APIName| Name }}{{APIPrefix|As String}}{{APIName|)}}{{APIComment|Initializes a new instance of the WeibullDataSet class with a specified [[WeibullDataSet.DatasetName|data set name]].}}
==Constructor==
Parameters
{| {{APITable}}
:''Name'': The name of the data set.
|-
| style="width: 200px;"|WeibullDataSet||Creates an instance of the WeibullDataSet class.
|-
|[[WeibullDataSet_Constructors|WeibullDataSet()]]||{{:WeibullDataSet_Constructors}}
|}


== Methods ==
Use these methods to enter data points into a data sheet and analyze them. The settings for the analysis are specified with this class's properties.


{| border="1" cellpadding="5" cellspacing="0"
== Methods==
| '''Name''' || '''Definition''' || '''Return Type'''  ||  '''Description'''
{| {{APITable}}
|-
|-
|colspan="4" style="padding-left: 20px; color: gray;"|''Add/Remove Data''
|style="width: 200px;"|[[WeibullDataSet.AddFailure|AddFailure]]||{{:WeibullDataSet.AddFailure}}
|-
|-
|AddFailure || {{Template:WeibullDataSet.AddFailure}}  || None  ||  {{Template:WeibullDataSet.AddFailure.Cmt}}
|[[WeibullDataSet.AddFailureInterval|AddFailureInterval]]||{{:WeibullDataSet.AddFailureInterval}}
|-
|-
|AddSuspension  || {{Template:WeibullDataSet.AddSuspension}}  || None  || {{Template:WeibullDataSet.AddSuspension.Cmt}}
|[[WeibullDataSet.AddFreeForm|AddFreeForm]]||{{:WeibullDataSet.AddFreeForm}}
|-
|-
|colspan="4" style="padding-left: 20px; color: gray;"|''Analyze Data''
|[[WeibullDataSet.AddSuspension|AddSuspension]]||{{:WeibullDataSet.AddSuspension}}
|-
|-
|Calculate  ||  {{Template:WeibullDataSet.Calculate}} || None || {{Template:WeibullDataSet.Calculate.Cmt}}
|[[WeibullDataSet.AddSuspensionInterval|AddSuspensionInterval]]||{{:WeibullDataSet.AddSuspensionInterval}}
|-
|-
|CalculateBestFit || {{Template:WeibullDataSet.CalculateBestFit}} || None || {{Template:WeibullDataSet.CalculateBestFit.Cmt}}
|[[WeibullDataSet.Calculate|Calculate]]||{{:WeibullDataSet.Calculate}}
|-
|[[WeibullDataSet.CalculateBestFit|CalculateBestFit]]||{{:WeibullDataSet.CalculateBestFit}}
|-
|[[WeibullDataSet.ClearDataSet|ClearDataSet]]||{{:WeibullDataSet.ClearDataSet}}
|-
|-
|}
|}




'''Add/Remove Data'''
==Properties==
*{{Template:WeibullDataSet.AddFailure}}
{| {{APITable}}
:{{APIComment|{{Template:WeibullDataSet.AddFailure.Cmt}}}}
|-
*{{Template:WeibullDataSet.AddSuspension}}
|style="width: 200px;"|AnalysisResults||Gets the '''[[WeibullAnalysisResults Class|WeibullAnalysisResults]]''' object that represents the correlation coefficient, likelihood ratio and PNZ values from the life data analysis.
:{{APIComment|{{Template:WeibullDataSet.AddSuspension.Cmt}}}}
|-
*'''[[WeibullDataSet.AddFailureInterval|AddFailureInterval]]''' {{APIComment|{{Template:WeibullDataSet.AddFailureInterval.Cmt}}}}
|Calculated||Indicates whether the data set has been analyzed. '''Boolean'''. Read only.
*'''[[WeibullDataSet.AddSuspensionInterval|AddSuspensionInterval]]''' {{APIComment|{{Template:WeibullDataSet.AddSuspensionInterval.Cmt}}}}
*'''[[WeibullDataSet.AddFreeForm|AddFreeForm]]''' {{APIComment|{{Template:WeibullDataSet.AddFreeForm.Cmt}}}}
*'''[[WeibullDataSet.ClearDataSet|ClearDataSet]]''' {{APIComment|{{Template:WeibullDataSet.ClearDataSet.Cmt}}}}
 
'''Analyze Data'''
*'''[[WeibullDataSet.Calculate|Calculate]]''' {{APIComment|{{Template:WeibullDataSet.Calculate.Cmt}}}}
*'''[[WeibullDataSet.CalculateBestFit|CalculateBestFit]]''' {{APIComment|{{Template:WeibullDataSet.CalculateBestFit.Cmt}}}}
 
== Properties  ==
Use these properties to specify analysis settings and view analysis results, as well as view or edit properties of the data set.
 
{| border="1" cellpadding="5" cellspacing="0"
| '''Name''' || '''Type''' || '''Description'''  
|-
|-
|colspan="3" style="padding-left: 20px; color: gray;"|''Analysis Settings''
|DataSetName||Gets or sets the name of the data set. '''String'''. If no name has been specified, the default name is "Set 1."
|-
|-
|FailureCount||Gets the total number of failures in the data set. '''Double'''
|-
|-
|AnalysisSettings || ''[[WeibullAnalysisOptions_Class|WeibullAnalysisOptions]]'' || {{Template:WeibullDataSet.AnalysisSettings.Cmt}}
|FittedModel||References the '''[[cModel Class|cModel]]''' object that represents the fitted model of the life data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.  
|-
|-
|BestFitSettings  || ''[[ WeibullBestFitOptions Class| WeibullBestFitOptions]]'' || {{Template:WeibullDataSet.BestFitSettings.Cmt}}
|SuspensionCount||Gets the total number of suspensions in the data set. '''Double'''
|-
|-
|GeneralSettings  || ''[[WeibullGeneralOptions Class|WeibullGeneralOptions]]'' || {{Template:WeibullDataSet.GeneralSettings.Cmt}}
|UseCalculationProgress||Indicates whether to display the progress bar while analyzing the data set. '''Boolean'''. Default value = True.
|-
|-
|colspan="3" style="padding-left: 20px; color: gray;"|''Analysis Results''
|UseEvents||Indicates whether to enable user-defined event procedures for the <code>WeibullDataSet</code> object. '''Boolean'''. Default value = False.
|}
 
==Fields==
{| {{APITable}}
|-
|-
|FittedModel  || ''[[CModel Class|cModel]]'' ||  {{Template:WeibullDataSet.FittedModel.Cmt}}
|style="width: 200px;"|AnalysisSettings||References the '''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]]''' object, which represents the analysis settings for the <code>Calculate</code> method. Read-Only.  
|-
|-
|AnalysisResults  || ''[[WeibullAnalysisResults Class|WeibullAnalysisResults]]'' || {{Template:WeibullDataSet.AnalysisResults.Cmt}}
|BestFitSettings||References the '''[[WeibullBestFitOptions Class|WeibullBestFitOptions]]''' object, which represents the analysis settings for the <code>CalculateBestFit</code> method. Read-Only.
|-
|-
|GeneralSettings||References the '''[[WeibullGeneralOptions Class|WeibullGeneralOptions]]''' object, which represents the calculation settings for both the <code>Calculate</code> and <code>CalculateBestFit</code> methods.  Read-Only.
|}
|}


'''Analysis Settings'''
*AnalysisSettings of type ''[[WeibullAnalysisOptions_Class|WeibullAnalysisOptions]]'' value.
:{{APIComment|{{Template:WeibullDataSet.AnalysisSettings.Cmt}}}}
*'''[[WeibullDataSet.BestFitSettings|BestFitSettings]]''' {{APIComment|{{Template:WeibullDataSet.BestFitSettings.Cmt}}}}
*'''[[WeibullDataSet.GeneralSettings|GeneralSettings]]''' {{APIComment|{{Template:WeibullDataSet.GeneralSettings.Cmt}}}}


'''Analysis Results'''
==Events==
*'''[[WeibullDataSet.FittedModel|FittedModel]]''' {{APIComment|{{Template:WeibullDataSet.FittedModel.Cmt}}}}
{| {{APITable}}
*'''[[WeibullDataSet.AnalysisResults|AnalysisResults]]''' {{APIComment|{{Template:WeibullDataSet.AnalysisResults.Cmt}}}}
|-
 
| style="width: 200px;"|[[WeibullDataSet.GetDistrParameters|GetDistrParameters]]||{{:WeibullDataSet.GetDistrParameters}}
'''Data Set Properties'''
|-
*'''[[WeibullDataSet.DatasetName|DatasetName]]''' {{APIComment|{{Template:WeibullDataSet.DatasetName.Cmt}}}}
|[[WeibullDataSet.HideCalculationProgress|HideCalculationProgress]]||{{:WeibullDataSet.HideCalculationProgress}}
*'''[[WeibullDataSet.FailureCount|FailureCount]]''' {{APIComment|{{Template:WeibullDataSet.FailureCount.Cmt}}}}
|-
*'''[[WeibullDataSet.SuspensionCount|SuspensionCount]]''' {{APIComment|{{Template:WeibullDataSet.SuspensionCount.Cmt}}}}
|[[WeibullDataSet.Message|Message]]||{{:WeibullDataSet.Message}}
 
|-
== Events ==
|[[WeibullDataSet.Question|Question]]||{{:WeibullDataSet.Question}}
*'''[[WeibullEvents Class]]''' {{APIComment|{{Template:WeibullEvents Class.Cmt}}}}
|-
|[[WeibullDataSet.ShowCalculationProgress|ShowCalculationProgress]]||{{:WeibullDataSet.ShowCalculationProgress}}
|-
|[[WeibullDataSet.UpdateCalculationProgress|UpdateCalculationProgress]]||{{:WeibullDataSet.UpdateCalculationProgress}}
|}

Latest revision as of 18:00, 16 January 2018

APIWiki.png


Member of: SynthesisAPI


Represents a data set for life data analysis.

Constructor

Name Description
WeibullDataSet Creates an instance of the WeibullDataSet class.
WeibullDataSet() A parameterized constructor for the WeibullDataSet class. (.NET only)


Methods

Name Description
AddFailure Adds a failure time to the data set.
AddFailureInterval Adds interval censored failures to the data set.
AddFreeForm Adds a free-form data point to the data set.
AddSuspension Adds suspensions to the data set.
AddSuspensionInterval Adds interval censored suspensions to the data set.
Calculate Fits a life distribution to the current data set and creates a cModel object that represents the fitted model.
CalculateBestFit Determines which of the selected life distributions best fits the data set (similar to the Distribution Wizard feature in Weibull++) and creates a cModel object that represents the fitted model of the recommended distribution.
ClearDataSet Clears all data in the data set and removes the fitted model, if any.


Properties

Name Description
AnalysisResults Gets the WeibullAnalysisResults object that represents the correlation coefficient, likelihood ratio and PNZ values from the life data analysis.
Calculated Indicates whether the data set has been analyzed. Boolean. Read only.
DataSetName Gets or sets the name of the data set. String. If no name has been specified, the default name is "Set 1."
FailureCount Gets the total number of failures in the data set. Double
FittedModel References the cModel object that represents the fitted model of the life data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.
SuspensionCount Gets the total number of suspensions in the data set. Double
UseCalculationProgress Indicates whether to display the progress bar while analyzing the data set. Boolean. Default value = True.
UseEvents Indicates whether to enable user-defined event procedures for the WeibullDataSet object. Boolean. Default value = False.

Fields

Name Description
AnalysisSettings References the WeibullAnalysisOptions object, which represents the analysis settings for the Calculate method. Read-Only.
BestFitSettings References the WeibullBestFitOptions object, which represents the analysis settings for the CalculateBestFit method. Read-Only.
GeneralSettings References the WeibullGeneralOptions object, which represents the calculation settings for both the Calculate and CalculateBestFit methods. Read-Only.


Events

Name Description
GetDistrParameters Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.
HideCalculationProgress Occurs when the calculation process is running. Hides the progress bar.
Message Occurs when an error is produced. Displays an error message.
Question Occurs when an answer to a question is required. Displays a message box with yes and no options.
ShowCalculationProgress Occurs when the calculation process is running. Displays a progress bar.
UpdateCalculationProgress Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullDataSet_Class&oldid=65290"