WeibullGeneralOptions Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global Weibull|Global Weibull}}
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:WeibullDataSet.GeneralSettings.Cmt}}


== Properties ==
'''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}}}}


== Formatted Usage Example ==
<onlyinclude>Represents the calculation settings of the associated [[WeibullDataSet Class|WeibullDataSet]] object.</onlyinclude>


{{APIComment|Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
== Properties  ==
        Dim WDS as New WeibullDataSet
{| {{APITable}}
|-
| style="width: 180px;"|AllowBiasingNormal||Indicates whether to correct the MLE standard deviation (sigma) value for biasedness (applies to complete data only). '''Boolean'''. Default value = False.
|-
|DiscardNegLocation||Indicates whether to discard the location parameter when it contains a negative value. '''Boolean'''. Default value = False.
|-
|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'''. Default value = True.
|-
|Use3PTrueMLE||Indicates whether to use a true 3-parameter MLE solution for 3-parameter Weibull. '''Boolean'''. Default value = False.
|-
|UseExtendedGGamma||Indicates whether to allow the lambda parameter of the generalized gamma distribution to take negative values. '''Boolean'''. Default value = True.
|-
|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'''. Default value = True.
|-
|WarnNegLocation||Indicates whether a warning will be generated when the location parameter contains a negative value. '''Boolean'''. Default value = False.
|}


{{APIComment|Set various settings.}}
 
        WDS.GeneralSettings.AllowBiasingNormal = False
== Example ==
        WDS.GeneralSettings.DiscardNegLocation = False
The following example demonstrates how to initialize the settings for a particular WeibullDataSet object.
        WDS.GeneralSettings.ResetExpLocation = True
 
        WDS.GeneralSettings.Use3PTrueMLE = False
'''VBA|VB.NET'''
        WDS.GeneralSettings.UseExtendedGGamma = False
        WDS.GeneralSettings.UsePlottedYPoints = False
{{APIComment|'Declare a new WeibullDataSet object.}}
        WDS.GeneralSettings.WarnNegLocation = False
  {{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

Latest revision as of 20:26, 24 June 2016

APIWiki.png


Member of: SynthesisAPI


Represents the calculation settings of the 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. Default value = False.
DiscardNegLocation Indicates whether to discard the location parameter when it contains a negative value. Boolean. Default value = False.
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. Default value = True.
Use3PTrueMLE Indicates whether to use a true 3-parameter MLE solution for 3-parameter Weibull. Boolean. Default value = False.
UseExtendedGGamma Indicates whether to allow the lambda parameter of the generalized gamma distribution to take negative values. Boolean. Default value = True.
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. Default value = True.
WarnNegLocation Indicates whether a warning will be generated when the location parameter contains a negative value. Boolean. Default value = False.


Example

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

VBA|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
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullGeneralOptions_Class&oldid=64418"