WeibullAnalysisResults Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 2 users not shown)
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 correlation coefficient, likelihood ratio and PNZ values from the life data analysis of the associated [[WeibullDataSet Class|WeibullDataSet]] object.</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), assuming the parameters of the distribution were estimated using rank regression. '''Double'''.
|-
|LikelihoodValue||Gets the likelihood function value (LK value). '''Double'''.
|-
|PercentNonZero||Gets the percent non-zero (Pnz) value of the data set. '''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.  
|}


== Formatted Usage Example ==


  {{APIComment|'Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
== Example ==
   Dim WDS as New WeibullDataSet
The following example demonstrates how to return the correlation coefficient of a particular WeibullDataSet object.
 
'''VBA'''
  {{APIComment|'Declare a WeibullDataSet object.}}
  {{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 object.}}
  {{APIPrefix|Dim}} WDS {{APIPrefix|as New}} WeibullDataSet
    
    
  {{APIComment|'Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]] for additional details.}}
  {{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|'Calculate the WeibullDataSet. See [[WeibullDataSet.CalculateBestFit|CalculateBestFit]] for additional details.}}
  {{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)

Latest revision as of 20:24, 24 June 2016

APIWiki.png


Member of: SynthesisAPI


Represents the correlation coefficient, likelihood ratio and PNZ values from the life data analysis of the associated WeibullDataSet object.

Properties

Name Description
CorrelationCoefficient Gets the correlation coefficient (rho value), assuming the parameters of the distribution were estimated using rank regression. Double.
LikelihoodValue Gets the likelihood function value (LK value). Double.
PercentNonZero Gets the percent non-zero (Pnz) value of the data set. 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

The following example demonstrates how to return the correlation coefficient of a particular WeibullDataSet object. 

VBA

 'Declare a WeibullDataSet object.  
  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 object.  
  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)
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullAnalysisResults_Class&oldid=64417"