WeibullAnalysisResults 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}}
Stores the correlation coefficient, likelihood value and percent non-zero values that were estimated from the analysis, if applicable.


These are equivalent to the "Rho," "LK Value" and "Pnz" results that can be shown in the Analysis Summary of the standard folio control panel.


== Properties==
<onlyinclude>Represents the additional results from the life data analysis (e.g., correlation coefficient, likelihood ratio, etc.).</onlyinclude>


*CorrelationCoefficient (as ''double'') {{APIComment|{{Template:WeibullAnalysisResults.CorrelationCoefficient.Cmt}}}}
== Properties  ==
*LikelihoodValue (as ''double'') {{APIComment|{{Template:WeibullAnalysisResults.LikelihoodValue.Cmt}}}}
{| {{APITable}}
*PercentNonZero (as ''double'') {{APIComment|{{Template:WeibullAnalysisResults.PercentNonZero.Cmt}}}}
|-
| style="width: 180px;"|CorrelationCoefficient||Gets the correlation coefficient (rho value) if the parameters were estimated using rank regression. '''Double'''.
|-
|LikelihoodValue||Gets the likelihood function value (LK value). '''Double'''.
|-
|PercentNonZero||Gets the percent non-zero (Pnz) value if the data set contains failure at ''t'' = 0. '''Double'''. A value of 1 indicates that there are no zero failure times in the data set; a decimal value indicates that the data set includes zero failure times.  
|}


== Usage Example ==


  {{APIComment|'Declare the WeibullDataSet. See [[WeibullDataSet Class|WeibullDataSet]].}}
== Example ==
  Dim WDS as New WeibullDataSet
 
VBA
  {{APIComment|'Declare a WeibullDataSet.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|as New}} WeibullDataSet
 
{{APIComment|'Add the failure times 10, 20 and 30 to the data set.}}
  {{APIPrefix|Call}} WDS.AddFailure(10, 1)
  {{APIPrefix|Call}} WDS.AddFailure(20, 1)
  {{APIPrefix|Call}} WDS.AddFailure(30, 1)
 
{{APIComment|'Fit the data to a life distribution, using all default settings.}}
  WDS.Calculate
 
{{APIComment|'Retrieve the value of the correlation coefficient.}}
  {{APIPrefix|Dim}} CorrCoeff {{APIPrefix|As}} Double
  CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
  Msgbox(CorrCoeff)
 
VB.NET
{{APIComment|'Declare a WeibullDataSet.}}  
  {{APIPrefix|Dim}} WDS {{APIPrefix|as New}} WeibullDataSet
    
    
  {{APIComment|'Add three failure times to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]].}}
  {{APIComment|'Add the failure times 10, 20 and 30 to the data set.}}
  WDS.AddFailure(1, 1)
  WDS.AddFailure(10, 1)
  WDS.AddFailure(2, 1)
  WDS.AddFailure(20, 1)
  WDS.AddFailure(3, 1)
  WDS.AddFailure(30, 1)
    
    
  {{APIComment|'Fit the data to a life distribution, using all default settings. See [[WeibullDataSet.CalculateBestFit|CalculateBestFit]].}}
  {{APIComment|'Fit the data to a life distribution, using all default settings.}}
  WDS.Calculate
  WDS.Calculate
    
    
  {{APIComment|'Retrieve the results.  In this example, the correlation coefficient result value is retrieved.}}
  {{APIComment|'Retrieve the value of the correlation coefficient.}}
  Dim CorrCoeff As Double
  {{APIPrefix|Dim}} CorrCoeff {{APIPrefix|As}} Double
  CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
  CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
  Msgbox(CorrCoeff)
 
==See Also==
*[[WeibullDataSet Class]]

Revision as of 21:46, 13 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents the additional results from the life data analysis (e.g., correlation coefficient, likelihood ratio, etc.).

Properties

Name Description
CorrelationCoefficient Gets the correlation coefficient (rho value) if the parameters were estimated using rank regression. Double.
LikelihoodValue Gets the likelihood function value (LK value). Double.
PercentNonZero Gets the percent non-zero (Pnz) value if the data set contains failure at t = 0. Double. A value of 1 indicates that there are no zero failure times in the data set; a decimal value indicates that the data set includes zero failure times.


Example

VBA

 'Declare a WeibullDataSet.  
  Dim WDS as New WeibullDataSet
 
 'Add the failure times 10, 20 and 30 to the data set. 
  Call WDS.AddFailure(10, 1)
  Call WDS.AddFailure(20, 1)
  Call WDS.AddFailure(30, 1)
 
 'Fit the data to a life distribution, using all default settings. 
  WDS.Calculate
 
 'Retrieve the value of the correlation coefficient. 
  Dim CorrCoeff As Double
  CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
  Msgbox(CorrCoeff)

VB.NET

 'Declare a WeibullDataSet.  
  Dim WDS as New WeibullDataSet
 
 'Add the failure times 10, 20 and 30 to the data set. 
  WDS.AddFailure(10, 1)
  WDS.AddFailure(20, 1)
  WDS.AddFailure(30, 1)
 
 'Fit the data to a life distribution, using all default settings. 
  WDS.Calculate
 
 'Retrieve the value of the correlation coefficient. 
  Dim CorrCoeff As Double
  CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
  Msgbox(CorrCoeff)

See Also

Retrieved from "https://www.reliawiki.com/index.php?title=WeibullAnalysisResults_Class&oldid=63337"