WeibullAnalysisOptions Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(53 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_Weibull|Global Weibull}}
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:WeibullAnalysisOptions Class.Cmt}}


== Syntax  ==
{{Template:WeibullAnalysisOptions.Distribution}}


{{Template:WeibullAnalysisOptions.Parameters}}
<onlyinclude>Represents the analysis settings of the associated [[WeibullDataSet Class|WeibullDataSet]] object.</onlyinclude>


{{Template:WeibullAnalysisOptions.Analysis}}
== Properties  ==
{| {{APITable}}
|-
| style="width: 180px;"|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'''. Default value = 0 (RRX).
|-
|Bayesian_Lambda||Gets or sets the value of the lambda parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow an exponential distribution. '''Double'''. Default value = 2.
|-
|Bayesian_MaxBeta||Gets or sets the maximum value of the beta parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a uniform distribution. '''Double'''. Default value = 2.
|-
|Bayesian_Mean||Gets or sets the value of the mean parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a normal distribution. '''Double'''. Default value = 2.
|-
|Bayesian_MinBeta||Gets or sets the minimum value of the beta parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a uniform distribution. '''Double'''. Default value = 1.
|-
|Bayesian_PriorDistribution||Gets or set a value from the '''[[WeibullBayesianPriorDistribution_Enumeration|WeibullBayesianPriorDistribution]]''' enumeration, which specifies the prior distribution for the Bayesian-Weibull analysis. Default value = 0 (normal distribution).
|-
|Bayesian_ResultsAs||Gets or sets a value from the '''[[WeibullBayesianResultsOption_Enumeration|WeibullBayesianResultsOption]]''' enumeration, which specifies whether to obtain the point estimates of beta from the median value or the mean value of the posterior distribution. Default value = 0 (median).
|-
|Bayesian_Std||Gets or sets the value of the standard deviation parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a normal distribution. '''Double'''. Default value = 1.
|-
|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).
|-
|Distribution||Gets or sets a value from the '''[[WeibullSolverDistribution_Enumeration|WeibullSolverDistribution]]''' enumeration, which specifies the life distribution to fit to the data set. Default value = 0 (Weibull distribution).
|-
|Parameters||Gets or sets a value from the '''[[WeibullSolverNumParameters_Enumeration|WeibullSolverNumParameters]]''' enumeration, which specifies the form of a distribution. Default value = 1 (2-parameter form)
|-
|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.
|-
|Subpopulations||Gets or sets the number of subpopulations in the data set. Applies to mixed Weibull analysis only. '''Integer'''. Default value = 2.
|-
|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, but is forced to True when analyzing interval censored data.
|-
|UseSpecialSort||Indicates whether failures will always be put before suspensions when two identical times are encountered. '''Boolean'''. Default value = True.
|-
|Weibull_UnbiasParameters||Indicates whether the biased beta estimate (due to MLE sampling error) will be corrected for the 2-parameter Weibull distribution. '''Boolean'''. Default value = False.
|}


{{Template:WeibullAnalysisOptions.RankingMethod}}


{{Template:WeibullAnalysisOptions.UseRSRegression}}
== Example ==
The following example demonstrates how to initialize some of the analysis settings for a particular WeibullDataSet object.


{{Template:WeibullAnalysisOptions.ConfBounds}}  
'''VBA'''
{{APIComment|'Declare a new WeibullDataSet object.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
 
{{APIComment|'Specify the analysis settings.}}
  WDS.AnalysisSettings.Analysis = WeibullSolverMethod_RRX
  WDS.AnalysisSettings.ConfBounds = WeibullSolverCBMethod_FisherMatrix
  WDS.AnalysisSettings.Distribution = WeibullSolverDistribution_Weibull
  WDS.AnalysisSettings.Parameters = WeibullSolverNumParameters_MS_2Parameter
  WDS.AnalysisSettings.RankingMethod = WeibullSolverRankMethod_Median
  WDS.AnalysisSettings.SortBeforeCalculations = True
  WDS.AnalysisSettings.UngroupGroupedData = False
  WDS.AnalysisSettings.UseRSRegression = False
  WDS.AnalysisSettings.UseSpecialSort = True
  WDS.AnalysisSettings.Weibull_UnbiasParameters = False
{{APIComment|'Add failure times to the data set.}}
  {{APIPrefix|Call}} WDS.AddFailure(100, 1)
  {{APIPrefix|Call}} WDS.AddFailure(120, 1)
  {{APIPrefix|Call}} WDS.AddFailure(130, 1) 
{{APIComment|'Analyze the data set.}}
  WDS.Calculate()


{{Template:WeibullAnalysisOptions.UngroupGroupedData}}  
'''VB.NET'''
 
{{Template:WeibullAnalysisOptions.Subpopulations}}  
{{APIComment|'Declare a new WeibullDataSet object.}}
 
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
{{Template:WeibullAnalysisOptions.Weibull_UnbiasParameters}}  
 
 
{{APIComment|'Specify the analysis settings.}}
{{Template:WeibullAnalysisOptions.Bayesian_PriorDistribution}}  
  WDS.AnalysisSettings.Analysis = WeibullSolverMethod.RRX
 
  WDS.AnalysisSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
{{Template:WeibullAnalysisOptions.Bayesian_Mean}}
  WDS.AnalysisSettings.Distribution = WeibullSolverDistribution.Weibull
 
  WDS.AnalysisSettings.Parameters = WeibullSolverNumParameters.MS_2Parameter
{{Template:WeibullAnalysisOptions.Bayesian_Std}}
  WDS.AnalysisSettings.RankingMethod = WeibullSolverRankMethod.Median
 
  WDS.AnalysisSettings.SortBeforeCalculations = True
{{Template:WeibullAnalysisOptions.Bayesian_Lambda}}
  WDS.AnalysisSettings.UngroupGroupedData = False
 
  WDS.AnalysisSettings.UseRSRegression = False
{{Template:WeibullAnalysisOptions.Bayesian_MinBeta}}
  WDS.AnalysisSettings.UseSpecialSort = True
 
  WDS.AnalysisSettings.Weibull_UnbiasParameters = False
{{Template:WeibullAnalysisOptions.Bayesian_MaxBeta}}
 
{{APIComment|'Add failure times to the data set.}}
{{Template:WeibullAnalysisOptions.Bayesian_ResultsAs}}  
  WDS.AddFailure(100, 1)
 
  WDS.AddFailure(120, 1)
{{Template:WeibullAnalysisOptions.SortBeforeCalculations}}
  WDS.AddFailure(130, 1) 
 
{{Template:WeibullAnalysisOptions.UseSpecialSort}}
{{APIComment|'Analyze the data set.}}
  WDS.Calculate()

Latest revision as of 20:27, 24 June 2016

APIWiki.png


Member of: SynthesisAPI


Represents the analysis settings of the associated WeibullDataSet object.

Properties

Name Description
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. Default value = 0 (RRX).
Bayesian_Lambda Gets or sets the value of the lambda parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow an exponential distribution. Double. Default value = 2.
Bayesian_MaxBeta Gets or sets the maximum value of the beta parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a uniform distribution. Double. Default value = 2.
Bayesian_Mean Gets or sets the value of the mean parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a normal distribution. Double. Default value = 2.
Bayesian_MinBeta Gets or sets the minimum value of the beta parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a uniform distribution. Double. Default value = 1.
Bayesian_PriorDistribution Gets or set a value from the WeibullBayesianPriorDistribution enumeration, which specifies the prior distribution for the Bayesian-Weibull analysis. Default value = 0 (normal distribution).
Bayesian_ResultsAs Gets or sets a value from the WeibullBayesianResultsOption enumeration, which specifies whether to obtain the point estimates of beta from the median value or the mean value of the posterior distribution. Default value = 0 (median).
Bayesian_Std Gets or sets the value of the standard deviation parameter of the prior distribution. Applies to Bayesian-Weibull analyses where the prior distribution of beta is assumed to follow a normal distribution. Double. Default value = 1.
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).
Distribution Gets or sets a value from the WeibullSolverDistribution enumeration, which specifies the life distribution to fit to the data set. Default value = 0 (Weibull distribution).
Parameters Gets or sets a value from the WeibullSolverNumParameters enumeration, which specifies the form of a distribution. Default value = 1 (2-parameter form)
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.
Subpopulations Gets or sets the number of subpopulations in the data set. Applies to mixed Weibull analysis only. Integer. Default value = 2.
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, but is forced to True when analyzing interval censored data.
UseSpecialSort Indicates whether failures will always be put before suspensions when two identical times are encountered. Boolean. Default value = True.
Weibull_UnbiasParameters Indicates whether the biased beta estimate (due to MLE sampling error) will be corrected for the 2-parameter Weibull distribution. Boolean. Default value = False.


Example

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

VBA

 'Declare a new WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Specify the analysis settings. 
  WDS.AnalysisSettings.Analysis = WeibullSolverMethod_RRX
  WDS.AnalysisSettings.ConfBounds = WeibullSolverCBMethod_FisherMatrix
  WDS.AnalysisSettings.Distribution = WeibullSolverDistribution_Weibull
  WDS.AnalysisSettings.Parameters = WeibullSolverNumParameters_MS_2Parameter
  WDS.AnalysisSettings.RankingMethod = WeibullSolverRankMethod_Median
  WDS.AnalysisSettings.SortBeforeCalculations = True
  WDS.AnalysisSettings.UngroupGroupedData = False
  WDS.AnalysisSettings.UseRSRegression = False
  WDS.AnalysisSettings.UseSpecialSort = True
  WDS.AnalysisSettings.Weibull_UnbiasParameters = False

 'Add failure times to the data set. 
  Call WDS.AddFailure(100, 1)
  Call WDS.AddFailure(120, 1)
  Call WDS.AddFailure(130, 1)  

 'Analyze the data set. 
  WDS.Calculate()

VB.NET

 'Declare a new WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Specify the analysis settings. 
  WDS.AnalysisSettings.Analysis = WeibullSolverMethod.RRX
  WDS.AnalysisSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
  WDS.AnalysisSettings.Distribution = WeibullSolverDistribution.Weibull
  WDS.AnalysisSettings.Parameters = WeibullSolverNumParameters.MS_2Parameter
  WDS.AnalysisSettings.RankingMethod = WeibullSolverRankMethod.Median
  WDS.AnalysisSettings.SortBeforeCalculations = True
  WDS.AnalysisSettings.UngroupGroupedData = False
  WDS.AnalysisSettings.UseRSRegression = False
  WDS.AnalysisSettings.UseSpecialSort = True
  WDS.AnalysisSettings.Weibull_UnbiasParameters = False

 'Add failure times to the data set. 
  WDS.AddFailure(100, 1)
  WDS.AddFailure(120, 1)
  WDS.AddFailure(130, 1)  

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