WeibullDataSet 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| }}  
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:WeibullDataSet Class.Cmt}}
{{Template:PlotsNote.Cmt}}


A usage example for this class is available [[WeibullDataSet Class Example|here]].


== Constructors ==
<onlyinclude>Represents a Weibull++ standard folio. </onlyinclude> The methods and properties in this class allow you to define a data set and fit a statistical distribution to the data.
*[[WeibullDataSet_Constructors|WeibullDataSet]]        {{APIComment|{{Template:WeibullDataSet Constructors1.Cmt}}}}
*[[WeibullDataSet_Constructors|WeibullDataSet( String )]]  {{APIComment|{{Template:WeibullDataSet Constructors2.Cmt}}}}


== Methods ==
==Constructor==
Use these methods to enter data points into a data sheet and analyze them. The settings for the analysis are specified with this class's properties.
{| {{APITable}}
|-
| style="width: 200px;"|WeibullDataSet||Creates an instance of the WeibullDataSet class.
|-
|[[WeibullDataSet_Constructors|WeibullDataSet()]]||A parameterized constructor for the WeibullDataSet class (VB.NET only)
|}


'''Add/Remove Data'''
*[[WeibullDataSet.AddFailure|AddFailure( Double, Integer )]]      {{APIComment|{{Template:WeibullDataSet.AddFailure.Cmt}}}}
*[[WeibullDataSet.AddSuspension|AddSuspension( Double, Integer )]] {{APIComment|{{Template:WeibullDataSet.AddSuspension.Cmt}}}}
*[[WeibullDataSet.AddFailureInterval|AddFailureInterval( Double, Double, Integer )]]        {{APIComment|{{Template:WeibullDataSet.AddFailureInterval.Cmt}}}}
*[[WeibullDataSet.AddSuspensionInterval|AddSuspensionInterval( Double, Double, Integer )]]  {{APIComment|{{Template:WeibullDataSet.AddSuspensionInterval.Cmt}}}}
*[[WeibullDataSet.AddFreeForm|AddFreeForm( Double, Double )]]                          {{APIComment|{{Template:WeibullDataSet.AddFreeForm.Cmt}}}}
*[[WeibullDataSet.ClearDataSet|ClearDataSet]]                    {{APIComment|{{Template:WeibullDataSet.ClearDataSet.Cmt}}}}


'''Analyze Data'''
== Methods==
*[[WeibullDataSet.Calculate|Calculate]]               {{APIComment|{{Template:WeibullDataSet.Calculate.Cmt}}}}
{| {{APITable}}
*[[WeibullDataSet.CalculateBestFit|CalculateBestFit]] {{APIComment|{{Template:WeibullDataSet.CalculateBestFit.Cmt}}}}
|-
|style="width: 200px;"|[[WeibullDataSet.AddFailure|AddFailure]]||{{:WeibullDataSet.AddFailure}}
|-
|[[WeibullDataSet.AddFailureInterval|AddFailureInterval]]||{{:WeibullDataSet.AddFailureInterval}}
|-
|[[WeibullDataSet.AddFreeForm|AddFreeForm]]||{{:WeibullDataSet.AddFreeForm}}
|-
|[[WeibullDataSet.AddSuspension|AddSuspension]]||{{:WeibullDataSet.AddSuspension}}
|-
|[[WeibullDataSet.AddSuspensionInterval|AddSuspensionInterval]]||{{:WeibullDataSet.AddSuspensionInterval}}
|-
|[[WeibullDataSet.Calculate|Calculate]]||{{:WeibullDataSet.Calculate}}
|-
|[[WeibullDataSet.CalculateBestFit|CalculateBestFit]]||{{:WeibullDataSet.CalculateBestFit}}
|-
|[[WeibullDataSet.ClearDataSet|ClearDataSet]]||{{:WeibullDataSet.ClearDataSet}}
|-
|}


== Properties  ==
Use these properties to specify analysis settings and view analysis results, as well as view or edit properties of the data set.


'''Analysis Settings'''
==Properties==
*AnalysisSettings (as ''[[WeibullAnalysisOptions_Class|WeibullAnalysisOptions]]'') {{APIComment|{{Template:WeibullDataSet.AnalysisSettings.Cmt}}}}
{| {{APITable}}
*BestFitSettings (as ''[[WeibullBestFitOptions_Class|WeibullBestFitOptions]]'') {{APIComment|{{Template:WeibullDataSet.BestFitSettings.Cmt}}}}
|-
*GeneralSettings (as ''[[WeibullGeneralOptions_Class|WeibullGeneralOptions]]'') {{APIComment|{{Template:WeibullDataSet.GeneralSettings.Cmt}}}}
|style="width: 200px;"|AnalysisResults||Gets a '''[[WeibullAnalysisResults Class|WeibullAnalysisResults]]''' object that represents the additional results from the life data analysis (e.g., correlation coefficient, likelihood ratio and pnz value).
|-
|AnalysisSettings||Gets a '''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]]''' object that represents the life data analysis settings (e.g., life distribution, MLE or RRX method, etc.) for the Calculate method.
|-
|BestFitSettings||Gets a '''[[WeibullBestFitOptions Class|WeibullBestFitOptions]]''' object that represents the analysis settings for the CalculateBestFit method.
|-
|Calculated||Indicates whether the data set has been analyzed. '''Boolean'''. Read only.
|-
|DataSetName||Gets or sets the name of the data set. '''String'''. If no name has been specified, the default name is "Set 1."
|-
|FailureCount||Gets the total number of failures in the data set. '''Integer'''
|-
|FittedModel||Gets the '''[[cModel Class|cModel]]''' object that represents the fitted model of the life data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.  
|-
|GeneralSettings||Gets a '''[[WeibullGeneralOptions Class|WeibullGeneralOptions]]''' object that represents the miscellaneous analysis settings for both the Calculate and CalculateBestFit methods.
|-
|SuspensionCount||Gets the total number of suspensions in the data set. '''Integer'''
|-
|UseCalculationProgress||Indicates whether to display the progress bar while analyzing the data set. '''Boolean'''. Default value is true.
|}


'''Analysis Results'''
*FittedModel (as ''[[cModel Class|cModel]]'') {{APIComment|{{Template:WeibullDataSet.FittedModel.Cmt}}}}
*AnalysisResults (as ''[[WeibullAnalysisResults Class|WeibullAnalysisResults]]'') {{APIComment|{{Template:WeibullDataSet.AnalysisResults.Cmt}}}}


'''Data Set Properties'''
*DatasetName (as ''string'') {{APIComment|{{Template:WeibullDataSet.DatasetName.Cmt}}}}
*FailureCount (as ''integer'') {{APIComment|{{Template:WeibullDataSet.FailureCount.Cmt}}}}
*SuspensionCount (as ''integer'') {{APIComment|{{Template:WeibullDataSet.SuspensionCount.Cmt}}}}


== Events  ==


The [[WeibullEvents Class|WeibullEvents]] class contains {{Template:WeibullEvents Class.Cmt}} <!--Shared with WeibullEvents_Class-->


The event handlers include:
==See Also==
 
*[[WAPlots Class]]
*[[WeibullEvents.Message|Message( WeibullDataSet, String, String,  Boolean )]] {{APIComment|{{Template:WeibullEvents.Message.Cmt}}}}
*[[WeibullEvents.Question|Question( WeibullDataSet, String, MsgBoxStyle, MsgBoxResult )]] {{APIComment|{{Template:WeibullEvents.Question.Cmt}}}}
*[[WeibullEvents.GetDistrParameters|GetDistrParameters( WeibullDataSet, String, Boolean, List( Of ParamInputInfo ), Boolean )]]{{APIComment|{{Template:WeibullEvents.GetDistrParameters.Cmt}}}}
*[[WeibullEvents.UpdateCalculationProgress|UpdateCalculationProgress( WeibullDataSet, String, String, Double, Boolean, Long, Boolean ) ]]{{APIComment|{{Template:WeibullEvents.UpdateCalculationProgress.Cmt}}}}
*[[WeibullEvents.ShowCalculationProgress|ShowCalculationProgress( WeibullDataSet )]]{{APIComment|{{Template:WeibullEvents.ShowCalculationProgress.Cmt}}}}
*[[WeibullEvents.HideCalculationProgress|HideCalculationProgress( WeibullDataSet )]]{{APIComment|{{Template:WeibullEvents.HideCalculationProgress.Cmt}}}}
 
== Usage Example ==
This example demonstrates how to fit a times-to-failure data set to a life distribution and then use the fitted distribution to calculate the reliability at a specified time. Full application examples are available at [[Synthesis_API_Reference#Application_Examples]].
 
{{APIComment|'Initialize a new WeibullDataSet object.}}
  Dim ADS As New WeibullDataSet("DataSet1")
 
{{APIComment|'Set the life distribution.}}
  WDS.AnalysisSettings.Distribution = WeibullSolverDistribution.Weibull
  WDS.AnalysisSettings.Parameters = WeibullSolverNumParameters.MS_2Parameter
 
{{APIComment|'Set the applicable analysis settings.}}
  WDS.AnalysisSettings.Analysis = WeibullSolverMethod.MLE
  WDS.AnalysisSettings.RankingMethod = WeibullSolverRankMethod.Median
  WDS.AnalysisSettings.UseRSRegression = False
  WDS.AnalysisSettings.ConfBounds = WeibullSolverCBMethod.FisherMatrix
  WDS.AnalysisSettings.SortBeforeCalculations = True
  WDS.AnalysisSettings.UngroupGroupedData = False
 
{{APIComment|'Set the Application Setup options.}}
  WDS.AnalysisSettings.UseSpecialSort = True
  WDS.GeneralSettings.AllowBiasingNormal = False
  WDS.GeneralSettings.DiscardNegLocation = False
  WDS.GeneralSettings.ResetExpLocation = False
  WDS.GeneralSettings.Use3PTrueMLE = False
  WDS.GeneralSettings.UseExtendedGGamma = False
  WDS.GeneralSettings.UsePlottedYPoints = False
  WDS.GeneralSettings.WarnNegLocation = False
 
{{APIComment|'Add failure times.}}
  WDS.AddFailure(16, 1)
  WDS.AddFailure(34, 1)
  WDS.AddFailure(53, 1)
  WDS.AddFailure(75, 1)
  WDS.AddFailure(93, 1)
  WDS.AddFailure(120, 1)
 
{{APIComment|'Add 4 suspensions.}}
  WDS.AddFailure(120, 4)
 
{{APIComment|'Fit failure times to the specified distribution.}}
  WDS.Calculate()
 
{{APIComment|'Get the reliability at 300 hours.}}
  Dim Rel As Double
  Rel = WDS.FittedModel.Reliability(300)

Revision as of 16:45, 14 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents a Weibull++ standard folio. The methods and properties in this class allow you to define a data set and fit a statistical distribution to the data.

Constructor

Name Description
WeibullDataSet Creates an instance of the WeibullDataSet class.
WeibullDataSet() A parameterized constructor for the WeibullDataSet class (VB.NET only)


Methods

Name Description
AddFailure Adds a failure time to the data set.
AddFailureInterval Adds interval censored failures to the data set.
AddFreeForm Adds a free-form data point to the data set.
AddSuspension Adds suspensions to the data set.
AddSuspensionInterval Adds interval censored suspensions to the data set.
Calculate Fits a life distribution to the current data set and creates a cModel object that represents the fitted model.
CalculateBestFit Determines which of the selected life distributions best fits the data set (similar to the Distribution Wizard feature in Weibull++) and creates a cModel object that represents the fitted model of the recommended distribution.
ClearDataSet Clears all data in the data set and removes the fitted model, if any.


Properties

Name Description
AnalysisResults Gets a WeibullAnalysisResults object that represents the additional results from the life data analysis (e.g., correlation coefficient, likelihood ratio and pnz value).
AnalysisSettings Gets a WeibullAnalysisOptions object that represents the life data analysis settings (e.g., life distribution, MLE or RRX method, etc.) for the Calculate method.
BestFitSettings Gets a WeibullBestFitOptions object that represents the analysis settings for the CalculateBestFit method.
Calculated Indicates whether the data set has been analyzed. Boolean. Read only.
DataSetName Gets or sets the name of the data set. String. If no name has been specified, the default name is "Set 1."
FailureCount Gets the total number of failures in the data set. Integer
FittedModel Gets the cModel object that represents the fitted model of the life data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.
GeneralSettings Gets a WeibullGeneralOptions object that represents the miscellaneous analysis settings for both the Calculate and CalculateBestFit methods.
SuspensionCount Gets the total number of suspensions in the data set. Integer
UseCalculationProgress Indicates whether to display the progress bar while analyzing the data set. Boolean. Default value is true.



See Also

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