WeibullBestFitOptions Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|WeibullDataSet_Class|WeibullDataSet}}
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:WeibullDataSet.BestFitSettings.Cmt}}


== Methods ==
*AllowAllDistributions    {{APIComment|Sets all the "Allow" properties to True.}}
*AllowNoneDistributions  {{APIComment|Sets all the "Allow" properties to False.}}


== Properties ==
<onlyinclude>Represents the settings for the goodness-of-fit tests of an associated [[WeibullDataSet Class|WeibullDataSet]] object.</onlyinclude>
'''Distribution Wizard Settings'''                 
*AllowExponential1      (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowExponential1.Cmt}}}}
*AllowExponential2      (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowExponential2.Cmt}}}}
*AllowNormal            (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowNormal.Cmt}}}}
*AllowLognormal        (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowLognormal.Cmt}}}}
*AllowWeibull2          (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowWeibull2.Cmt}}}}
*AllowWeibull3          (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowWeibull3.Cmt}}}}
*AllowGamma            (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowGamma.Cmt}}}}
*AllowGenGamma          (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowGenGamma.Cmt}}}}
*AllowLogistic          (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowLogistic.Cmt}}}}
*AllowLoglogistic      (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowLoglogistic.Cmt}}}}
*AllowGumbel            (type: ''boolean'')    {{APIComment|{{Template:WeibullBestFitOptions.AllowGumbel.Cmt}}}}


'''General Analysis (Control Panel) Settings'''
==Method ==
<!--Using same comments from WeibullAnalysisOptions_Class-->
{| {{APITable}}
*Analysis                  (as ''[[WeibullSolverMethod Enumeration|WeibullSolverMethod]]'')    {{APIComment|{{Template:WeibullAnalysisOptions.Analysis.Cmt}}}} 
|-
*RankingMethod            (as ''[[WeibullSolverRankMethod Enumeration|WeibullSolverRankMethod]]''){{APIComment|{{Template:WeibullAnalysisOptions.RankingMethod.Cmt}}}}
| style="width: 200px;"|AllowAllDistributions||Sets the first eleven properties in the class (as shown below) to true.
*UseRSRegression          (as ''boolean'')                   {{APIComment|{{Template:WeibullAnalysisOptions.UseRSRegression.Cmt}}}}
|-
*ConfBounds                (as ''[[WeibullSolverCBMethod Enumeration|WeibullSolverCBMethod]]'')  {{APIComment|{{Template:WeibullAnalysisOptions.ConfBounds.Cmt}}}}
|AllowNoneDistributions||Sets the first eleven properties in the class (as shown below) to false.
*SortBeforeCalculations    (as ''boolean'')                   {{APIComment|{{Template:WeibullAnalysisOptions.SortBeforeCalculations.Cmt}}}}
|}
*UngroupGroupedData        (as ''boolean'')                    {{APIComment|{{Template:WeibullAnalysisOptions.UngroupGroupedData.Cmt}}}}


'''Application Setup Option'''


*UseSpecialSort        (type: ''[[WeibullSolverMethod Enumeration|WeibullSolverMethod]]'')     {{APIComment|{{Template:WeibullBestFitOptions.UseSpecialSort.Cmt}}}}
==Properties==
{| {{APITable}}
|-
| style="width: 200px;"|AllowExponential1||Indicates whether the 1-parameter exponential distribution will be considered. '''Boolean'''
|-
|AllowExponential1||Indicates whether the 2-parameter exponential distribution will be considered. '''Boolean'''
|-
|AllowNormal||Indicates whether the normal distribution will be considered. '''Boolean'''
|-
|AllowLognormal||Indicates whether the lognormal distribution will be considered. '''Boolean'''
|-
|AllowWeibull2||Indicates whether the 2-parameter Weibull distribution will be considered. '''Boolean'''
|-
|AllowWeibull3||Indicates whether the 3-parameter exponential distribution will be considered. '''Boolean'''
|-
|AllowGamma||Indicates whether the gamma distribution will be considered. '''Boolean'''
|-
|AllowGenGamma||Indicates whether the generalized gamma will be considered. '''Boolean'''
|-
|AllowLogistic||Indicates whether the logistic distribution will be considered. '''Boolean'''
|-
|AllowLogLogistic||Indicates whether the log-logistic distribution will be considered. '''Boolean'''
|-
|AllowGumbel||Indicates whether the Gumbel distribution will be considered. '''Boolean'''
|-
|Analysis||Gets or sets a value from the '''[[WeibullSolverMethod_Enumeration|WeibullSolverMethod]]''' enumeration, which specifies the method (e.g., RRX, MLE, etc.) for estimating the parameters of the distribution. '''Double'''.
|-
|ConfBounds||Gets or sets a value from the '''[[WeibullSolverCBMethod_Enumeration|WeibullSolverCBMethod]]''' enumeration, which specifies the method for calculating the confidence bounds (e.g., Fisher Matrix).
|-
|RankingMethod||Gets or sets a value from the '''[[WeibullSolverRankMethod_Enumeration|WeibullSolverRankMethod]]''' enumeration, which specifies the rank method (e.g., median ranks or Kaplan-Meier) for calculating the unreliability estimates of the times-to-failure data.
|-
|SortBeforeCalculations||Indicates whether the failures/suspension times in the data set are sorted in ascending order before calculation. '''Boolean'''.
|-
|UngroupedGroupedData||Indicates whether to ungroup a grouped data set when using rank regression. '''Boolean'''.
|-
|UseRSRegression||Indicates whether to use ReliaSoft's ranking method (RRM) to calculate the unreliability estimates for times-to-failure data. '''Boolean'''.
|-
|UseSpecialSort||Indicates whether failures will always be put before suspensions when two identical times are encountered.. '''Boolean'''.
|}


== Formatted Usage Example ==
== Example ==
The following example demonstrates how to initialize the goodness-of-fit analysis settings for a particular WeibullDataSet object.


  {{APIComment|'Declare the WeibullDataSet. See [[WeibullDataSet Class|WeibullDataSet]].}}
'''VBA'''
  Dim WDS as New WeibullDataSet
 
  {{APIComment|'Declare a new WeibullDataSet object.}}
  {{APIComment|'Specify the settings.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
  WDS.BestFitSettings.AllowExponential1 = True
 
  WDS.BestFitSettings.AllowExponential2 = True
  {{APIComment|'Specify the analysis settings.}}
  WDS.BestFitSettings.AllowNormal = True
  WDS.BestFitSettings.AllowAllDistributions
  WDS.BestFitSettings.AllowLognormal = True
  WDS.BestFitSettings.Analysis = WeibullSolverMethod_MLE
  WDS.BestFitSettings.AllowWeibull2 = True
  WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod_FisherMatrix
  WDS.BestFitSettings.AllowWeibull3 = True
  WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod_Median
  WDS.BestFitSettings.AllowGamma = True
  WDS.BestFitSettings.SortBeforeCalculations = True
  WDS.BestFitSettings.AllowGenGamma = True
  WDS.BestFitSettings.UngroupGroupedData = False
  WDS.BestFitSettings.AllowLogistic = True
  WDS.BestFitSettings.UseRSRegression = False
  WDS.BestFitSettings.AllowLoglogistic = True
  WDS.BestFitSettings.UseSpecialSort = True
   WDS.BestFitSettings.AllowGumbel = True
  WDS.BestFitSettings.Analysis = WeibullSolverMethod.MLE
{{APIComment|'Add failure times to the data set.}}
  WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod.Median
  {{APIPrefix|Call}} WDS.AddFailure(10, 1)
  WDS.BestFitSettings.UseRSRegression = False
  {{APIPrefix|Call}} WDS.AddFailure(20, 1)
  WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
  {{APIPrefix|Call}} WDS.AddFailure(30, 1) 
  WDS.BestFitSettings.UngroupGroupedData = False
  WDS.BestFitSettings.SortBeforeCalculations = True
{{APIComment|'Analyze the data set.}}
  WDS.BestFitSettings.UseSpecialSort = True
  {{APIPrefix|Call}} WDS.CalculateBestFit()
 
'''VB.NET'''
{{APIComment|'Declare a new WeibullDataSet object.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
    
{{APIComment|'Specify the analysis settings.}}
  {{APIPrefix|Call}} WDS.BestFitSettings.AllowAllDistributions
  WDS.BestFitSettings.Analysis = WeibullSolverMethod.MLE
  WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
  WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod.Median
  WDS.BestFitSettings.SortBeforeCalculations = True
  WDS.BestFitSettings.UngroupGroupedData = False
  WDS.BestFitSettings.UseRSRegression = False
  WDS.BestFitSettings.UseSpecialSort = True
{{APIComment|'Add failure times to the data set.}}
  WDS.AddFailure(10, 1)
  WDS.AddFailure(20, 1)
  WDS.AddFailure(30, 1) 
{{APIComment|'Analyze the data set.}}
  WDS.CalculateBestFit()

Revision as of 23:57, 13 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents the settings for the goodness-of-fit tests of an associated WeibullDataSet object.

Method

Name Description
AllowAllDistributions Sets the first eleven properties in the class (as shown below) to true.
AllowNoneDistributions Sets the first eleven properties in the class (as shown below) to false.


Properties

Name Description
AllowExponential1 Indicates whether the 1-parameter exponential distribution will be considered. Boolean
AllowExponential1 Indicates whether the 2-parameter exponential distribution will be considered. Boolean
AllowNormal Indicates whether the normal distribution will be considered. Boolean
AllowLognormal Indicates whether the lognormal distribution will be considered. Boolean
AllowWeibull2 Indicates whether the 2-parameter Weibull distribution will be considered. Boolean
AllowWeibull3 Indicates whether the 3-parameter exponential distribution will be considered. Boolean
AllowGamma Indicates whether the gamma distribution will be considered. Boolean
AllowGenGamma Indicates whether the generalized gamma will be considered. Boolean
AllowLogistic Indicates whether the logistic distribution will be considered. Boolean
AllowLogLogistic Indicates whether the log-logistic distribution will be considered. Boolean
AllowGumbel Indicates whether the Gumbel distribution will be considered. Boolean
Analysis Gets or sets a value from the WeibullSolverMethod enumeration, which specifies the method (e.g., RRX, MLE, etc.) for estimating the parameters of the distribution. Double.
ConfBounds Gets or sets a value from the WeibullSolverCBMethod enumeration, which specifies the method for calculating the confidence bounds (e.g., Fisher Matrix).
RankingMethod Gets or sets a value from the WeibullSolverRankMethod enumeration, which specifies the rank method (e.g., median ranks or Kaplan-Meier) for calculating the unreliability estimates of the times-to-failure data.
SortBeforeCalculations Indicates whether the failures/suspension times in the data set are sorted in ascending order before calculation. Boolean.
UngroupedGroupedData Indicates whether to ungroup a grouped data set when using rank regression. Boolean.
UseRSRegression Indicates whether to use ReliaSoft's ranking method (RRM) to calculate the unreliability estimates for times-to-failure data. Boolean.
UseSpecialSort Indicates whether failures will always be put before suspensions when two identical times are encountered.. Boolean.

Example

The following example demonstrates how to initialize the goodness-of-fit analysis settings for a particular WeibullDataSet object. 

VBA

 'Declare a new WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Specify the analysis settings. 
  WDS.BestFitSettings.AllowAllDistributions
  WDS.BestFitSettings.Analysis = WeibullSolverMethod_MLE
  WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod_FisherMatrix
  WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod_Median
  WDS.BestFitSettings.SortBeforeCalculations = True
  WDS.BestFitSettings.UngroupGroupedData = False
  WDS.BestFitSettings.UseRSRegression = False
  WDS.BestFitSettings.UseSpecialSort = True

 'Add failure times to the data set. 
  Call WDS.AddFailure(10, 1)
  Call WDS.AddFailure(20, 1)
  Call WDS.AddFailure(30, 1)  

 'Analyze the data set. 
  Call WDS.CalculateBestFit()

VB.NET

 'Declare a new WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Specify the analysis settings. 
  Call WDS.BestFitSettings.AllowAllDistributions
  WDS.BestFitSettings.Analysis = WeibullSolverMethod.MLE
  WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
  WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod.Median
  WDS.BestFitSettings.SortBeforeCalculations = True
  WDS.BestFitSettings.UngroupGroupedData = False
  WDS.BestFitSettings.UseRSRegression = False
  WDS.BestFitSettings.UseSpecialSort = True

 'Add failure times to the data set. 
  WDS.AddFailure(10, 1)
  WDS.AddFailure(20, 1)
  WDS.AddFailure(30, 1)  

 'Analyze the data set. 
  WDS.CalculateBestFit()
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullBestFitOptions_Class&oldid=63347"