WeibullGeneralOptions Class: Difference between revisions

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


In Weibull++, these settings can be found on the Calculations page of the Application Setup window.


== Properties ==
<onlyinclude>Represents miscellaneous analysis settings for an associated [[WeibullDataSet Class|WeibullDataSet]] object.</onlyinclude>
'''Special Options on Location Parameter'''
*WarnNegLocation    (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.WarnNegLocation.Cmt}}}}
*DiscardNegLocation (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.DiscardNegLocation.Cmt}}}}
*ResetExpLocation  (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.ResetExpLocation.Cmt}}}}
*Use3PTrueMLE      (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.Use3TrueMLE.Cmt}}}}
*UseExtendedGGamma  (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.UseExtendedGGamma.Cmt}}}}
'''Other Options'''
*AllowBiasingNormal (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.AllowBiasingNormal.Cmt}}}}
*UsePlottedYPoints  (type: ''boolean'') {{APIComment|{{Template:WeibullGeneralOptions.UsePlottedYPoints.Cmt}}}}


== Usage Example ==
== Properties  ==
{| {{APITable}}
|-
| style="width: 180px;"|AllowBiasingNormal||Indicates whether to correct the MLE standard deviation (sigma) value for biasedness (applies to complete data only). '''Boolean'''.
|-
|DiscardNegLocation||Indicates whether to discard the location parameter when it contains a negative value. '''Boolean'''.
|-
|ResetExpLocation||Indicates whether to reset the value of the location parameter equal to the first failure time, T1, if the parameter is greater than T1. (Exponential distribution only.) '''Boolean'''.
|-
|Use3PTrueMLE||Indicates whether to use a true 3-parameter MLE solution for 3-parameter Weibull. '''Boolean'''.
|-
|UseExtendedGGamma||Indicates whether to allow the lambda parameter of the generalized gamma distribution to take negative values. '''Boolean'''.
|-
|UsePlottedYPoints||Indicates whether to use the plotted points (using median ranks or Kaplan-Meier) to calculate the difference between observed and model estimated probability for the Kolmogorov-Smirnov test. '''Boolean'''.
|-
|WarnNegLocation||Indicates whether a warning will be generated when the location parameter contains a negative value. '''Boolean'''.
|}


  {{APIComment|'Declare the WeibullDataSet. See [[WeibullDataSet Class|WeibullDataSet]].}}
 
  Dim WDS as New WeibullDataSet
== Example ==
 
'''VBA'''
  {{APIComment|'Declare a new WeibullDataSet object.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
 
{{APIComment|'Specify the settings.}}
  WDS.GeneralSettings.AllowBiasingNormal = False
  WDS.GeneralSettings.DiscardNegLocation = False
  WDS.GeneralSettings.ResetExpLocation = True
  WDS.GeneralSettings.Use3PTrueMLE = False
  WDS.GeneralSettings.UseExtendedGGamma = False
  WDS.GeneralSettings.UsePlottedYPoints = False
  WDS.GeneralSettings.WarnNegLocation = 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()
 
'''VB.NET'''
{{APIComment|'Declare a new WeibullDataSet object.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
    
    
  {{APIComment|'Specify the settings.}}
  {{APIComment|'Specify the settings.}}
  WDS.GeneralSettings.AllowBiasingNormal = False
  WDS.GeneralSettings.AllowBiasingNormal = False
  WDS.GeneralSettings.DiscardNegLocation = False
  WDS.GeneralSettings.DiscardNegLocation = False
  WDS.GeneralSettings.ResetExpLocation = True
  WDS.GeneralSettings.ResetExpLocation = True
  WDS.GeneralSettings.Use3PTrueMLE = False
  WDS.GeneralSettings.Use3PTrueMLE = False
  WDS.GeneralSettings.UseExtendedGGamma = False
  WDS.GeneralSettings.UseExtendedGGamma = False
  WDS.GeneralSettings.UsePlottedYPoints = False
  WDS.GeneralSettings.UsePlottedYPoints = False
  WDS.GeneralSettings.WarnNegLocation = False
  WDS.GeneralSettings.WarnNegLocation = False
 
{{APIComment|'Add failure times to the data set.}}
  WDS.AddFailure(100, 1)
  WDS.AddFailure(120, 1)
  WDS.AddFailure(130, 1) 
{{APIComment|'Analyze the data set.}}
  WDS.Calculate()

Revision as of 16:15, 14 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents miscellaneous analysis settings for an associated WeibullDataSet object.

Properties

Name Description
AllowBiasingNormal Indicates whether to correct the MLE standard deviation (sigma) value for biasedness (applies to complete data only). Boolean.
DiscardNegLocation Indicates whether to discard the location parameter when it contains a negative value. Boolean.
ResetExpLocation Indicates whether to reset the value of the location parameter equal to the first failure time, T1, if the parameter is greater than T1. (Exponential distribution only.) Boolean.
Use3PTrueMLE Indicates whether to use a true 3-parameter MLE solution for 3-parameter Weibull. Boolean.
UseExtendedGGamma Indicates whether to allow the lambda parameter of the generalized gamma distribution to take negative values. Boolean.
UsePlottedYPoints Indicates whether to use the plotted points (using median ranks or Kaplan-Meier) to calculate the difference between observed and model estimated probability for the Kolmogorov-Smirnov test. Boolean.
WarnNegLocation Indicates whether a warning will be generated when the location parameter contains a negative value. Boolean.


Example

VBA

 'Declare a new WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Specify the settings. 
  WDS.GeneralSettings.AllowBiasingNormal = False
  WDS.GeneralSettings.DiscardNegLocation = False
  WDS.GeneralSettings.ResetExpLocation = True
  WDS.GeneralSettings.Use3PTrueMLE = False
  WDS.GeneralSettings.UseExtendedGGamma = False
  WDS.GeneralSettings.UsePlottedYPoints = False
  WDS.GeneralSettings.WarnNegLocation = 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 settings. 
  WDS.GeneralSettings.AllowBiasingNormal = False
  WDS.GeneralSettings.DiscardNegLocation = False
  WDS.GeneralSettings.ResetExpLocation = True
  WDS.GeneralSettings.Use3PTrueMLE = False
  WDS.GeneralSettings.UseExtendedGGamma = False
  WDS.GeneralSettings.UsePlottedYPoints = False
  WDS.GeneralSettings.WarnNegLocation = 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=WeibullGeneralOptions_Class&oldid=63356"