WeibullBestFitOptions Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|WeibullDataSet_Class|WeibullDataSet}}
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:WeibullDataSet.BestFitSettings.Cmt}}


== Properties ==
'''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 Settings'''
<onlyinclude>Represents the analysis settings for the [[WeibullDataSet.CalculateBestFit|CalculateBestFit]] method of the associated [[WeibullDataSet Class|WeibullDataSet]] object.</onlyinclude>
<!--Using same comments from WeibullAnalysisOptions_Class-->
*Analysis                  (as ''[[WeibullSolverMethod Enumeration|WeibullSolverMethod]]'')    {{APIComment|{{Template:WeibullAnalysisOptions.Analysis.Cmt}}}} 
*RankingMethod            (as ''[[WeibullSolverRankMethod Enumeration|WeibullSolverRankMethod]]''){{APIComment|{{Template:WeibullAnalysisOptions.RankingMethod.Cmt}}}}
*UseRSRegression          (as ''boolean'')                    {{APIComment|{{Template:WeibullAnalysisOptions.UseRSRegression.Cmt}}}}
*ConfBounds                (as ''[[WeibullSolverCBMethod Enumeration|WeibullSolverCBMethod]]'')  {{APIComment|{{Template:WeibullAnalysisOptions.ConfBounds.Cmt}}}}
*SortBeforeCalculations    (as ''boolean'')                    {{APIComment|{{Template:WeibullAnalysisOptions.SortBeforeCalculations.Cmt}}}}
*UngroupGroupedData        (as ''boolean'')                    {{APIComment|{{Template:WeibullAnalysisOptions.UngroupGroupedData.Cmt}}}}


'''Application Setup Option'''
==Methods ==
{| {{APITable}}
|-
| style="width: 200px;"|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.
|}


*UseSpecialSort        (type: ''[[WeibullSolverMethod Enumeration|WeibullSolverMethod]]'')    {{APIComment|{{Template:WeibullBestFitOptions.UseSpecialSort.Cmt}}}}


== Formatted Usage Example ==
==Properties==
{| {{APITable}}
|-
| style="width: 200px;"|AllowExponential1||Indicates whether the 1-parameter exponential distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowExponential2||Indicates whether the 2-parameter exponential distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowGamma||Indicates whether the gamma distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowGenGamma||Indicates whether the generalized gamma distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowGumbel||Indicates whether the Gumbel distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowLogistic||Indicates whether the logistic distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowLogLogistic||Indicates whether the loglogistic distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowLognormal||Indicates whether the lognormal distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowNormal||Indicates whether the normal distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowWeibull2||Indicates whether the 2-parameter Weibull distribution will be considered. '''Boolean'''. Default value = True.
|-
|AllowWeibull3||Indicates whether the 3-parameter exponential distribution will be considered. '''Boolean'''. Default value = True.
|-
|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. Default value = 0 (RRX).
|-
|ConfBounds||Gets or sets a value from the '''[[WeibullSolverCBMethod_Enumeration|WeibullSolverCBMethod]]''' enumeration, which specifies the method for calculating the confidence bounds. Default value = 0 (Fisher Matrix method).
|-
|RankingMethod||Gets or sets a value from the '''[[WeibullSolverRankMethod_Enumeration|WeibullSolverRankMethod]]''' enumeration, which specifies the rank method for calculating the unreliability estimates of the times-to-failure data. Default value = 0 (median ranks).
|-
|SortBeforeCalculations||Indicates whether the failures/suspension times in the data set are sorted in ascending order before calculation. '''Boolean'''. Default value = True.
|-
|UngroupedGroupedData||Indicates whether to ungroup a grouped data set when using rank regression. '''Boolean'''. Default value = False.
|-
|UseRSRegression||Indicates whether to use ReliaSoft's ranking method (RRM) to calculate the unreliability estimates for times-to-failure data. '''Boolean'''. Default value = False.
|-
|UseSpecialSort||Indicates whether failures will always be put before suspensions when two identical times are encountered. '''Boolean'''. Default value = True.
|}


{{APIComment|Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
        Dim WDS as New WeibullDataSet


{{APIComment|Set the various Settings.}}
== Example ==
        WDS.BestFitSettings.AllowExponential1 = True
The following example demonstrates how to initialize the goodness of fit analysis settings for a particular WeibullDataSet object.
        WDS.BestFitSettings.AllowExponential2 = True
 
        WDS.BestFitSettings.AllowNormal = True
'''VBA'''
        WDS.BestFitSettings.AllowLognormal = True
        WDS.BestFitSettings.AllowWeibull2 = True
{{APIComment|'Declare a new WeibullDataSet object.}}
        WDS.BestFitSettings.AllowWeibull3 = True
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
        WDS.BestFitSettings.AllowGamma = True
 
        WDS.BestFitSettings.AllowGenGamma = True
{{APIComment|'Specify the analysis settings.}}
        WDS.BestFitSettings.AllowLogistic = True
  WDS.BestFitSettings.AllowAllDistributions
        WDS.BestFitSettings.AllowLoglogistic = True
  WDS.BestFitSettings.Analysis = WeibullSolverMethod_MLE
        WDS.BestFitSettings.AllowGumbel = True
  WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod_FisherMatrix
        WDS.BestFitSettings.Analysis = WeibullSolverMethod.MLE
  WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod_Median
        WDS.BestFitSettings.RankingMethod = WeibullSolverRankMethod.Median
  WDS.BestFitSettings.SortBeforeCalculations = True
        WDS.BestFitSettings.UseRSRegression = False
  WDS.BestFitSettings.UngroupGroupedData = False
        WDS.BestFitSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
  WDS.BestFitSettings.UseRSRegression = False
        WDS.BestFitSettings.UngroupGroupedData = False
  WDS.BestFitSettings.UseSpecialSort = True
        WDS.BestFitSettings.SortBeforeCalculations = True
        WDS.BestFitSettings.UseSpecialSort = True
{{APIComment|'Add failure times to the data set.}}
  {{APIPrefix|Call}} WDS.AddFailure(10, 1)
  {{APIPrefix|Call}} WDS.AddFailure(20, 1)
  {{APIPrefix|Call}} WDS.AddFailure(30, 1) 
{{APIComment|'Analyze the data set.}}
  {{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()

Latest revision as of 20:29, 24 June 2016

APIWiki.png


Member of: SynthesisAPI


Represents the analysis settings for the CalculateBestFit method of the associated WeibullDataSet object.

Methods

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. Default value = True.
AllowExponential2 Indicates whether the 2-parameter exponential distribution will be considered. Boolean. Default value = True.
AllowGamma Indicates whether the gamma distribution will be considered. Boolean. Default value = True.
AllowGenGamma Indicates whether the generalized gamma distribution will be considered. Boolean. Default value = True.
AllowGumbel Indicates whether the Gumbel distribution will be considered. Boolean. Default value = True.
AllowLogistic Indicates whether the logistic distribution will be considered. Boolean. Default value = True.
AllowLogLogistic Indicates whether the loglogistic distribution will be considered. Boolean. Default value = True.
AllowLognormal Indicates whether the lognormal distribution will be considered. Boolean. Default value = True.
AllowNormal Indicates whether the normal distribution will be considered. Boolean. Default value = True.
AllowWeibull2 Indicates whether the 2-parameter Weibull distribution will be considered. Boolean. Default value = True.
AllowWeibull3 Indicates whether the 3-parameter exponential distribution will be considered. Boolean. Default value = True.
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. Default value = 0 (RRX).
ConfBounds Gets or sets a value from the WeibullSolverCBMethod enumeration, which specifies the method for calculating the confidence bounds. Default value = 0 (Fisher Matrix method).
RankingMethod Gets or sets a value from the WeibullSolverRankMethod enumeration, which specifies the rank method for calculating the unreliability estimates of the times-to-failure data. Default value = 0 (median ranks).
SortBeforeCalculations Indicates whether the failures/suspension times in the data set are sorted in ascending order before calculation. Boolean. Default value = True.
UngroupedGroupedData Indicates whether to ungroup a grouped data set when using rank regression. Boolean. Default value = False.
UseRSRegression Indicates whether to use ReliaSoft's ranking method (RRM) to calculate the unreliability estimates for times-to-failure data. Boolean. Default value = False.
UseSpecialSort Indicates whether failures will always be put before suspensions when two identical times are encountered. Boolean. Default value = True.


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=64422"