ALTADataSet Class: Difference between revisions

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


== Constructors ==
*[[ALTADataSet_Constructors|ALTADataSet]]          {{APIComment|{{Template:ALTADataSet_Constructors1.Cmt}}}}
*[[ALTADataSet_Constructors|ALTADataSet( String )]]  {{APIComment|{{Template:ALTADataSet_Constructors2.Cmt}}}}


== Methods  ==
<onlyinclude>Represents an ALTA standard folio data sheet. </onlyinclude> The methods and properties in this class allow you to define a data set and fit a distribution and life-stress relationship to the data.
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.


'''Add Stresses and Stress Profiles'''
==Constructor==
*[[ALTADataSet.AddStressDefinition|AddStressDefinition( String, [ALTASolverLSR], [Double] )]] {{APIComment|{{Template:ALTADataSet.AddStressDefinition.Cmt}}}}
{| {{APITable}}
*[[ALTADataSet.AddStressProfile|AddStressProfile( ALTAStressProfile )]] {{APIComment|{{Template:ALTADataSet.AddStressProfile.Cmt}}}}
|-
| style="width: 200px;"|ALTADataSet||Creates an instance of the ALTADataSet class.  
|-
|[[ALTADataSet_Constructors|ALTADataSet()]]||{{:ALTADataSet_Constructors}}
|}


'''Add/Remove Data'''
*[[ALTADataSet.AddFailure|AddFailure( Double, Integer, Object() )]]      {{APIComment|{{Template:ALTADataSet.AddFailure1.Cmt}}}}
*[[ALTADataSet.AddFailure|AddFailure( Double, Integer, Object )]]        {{APIComment|{{Template:ALTADataSet.AddFailure2.Cmt}}}}
*[[ALTADataSet.AddFailure|AddFailure( Double, Integer, Object, Object )]] {{APIComment|{{Template:ALTADataSet.AddFailure3.Cmt}}}}
*[[ALTADataSet.AddSuspension|AddSuspension( Double, Integer, Object() )]]        {{APIComment|{{Template:ALTADataSet.AddSuspension1.Cmt}}}}
*[[ALTADataSet.AddSuspension|AddSuspension( Double, Integer, Object )]]        {{APIComment|{{Template:ALTADataSet.AddSuspension2.Cmt}}}}
*[[ALTADataSet.AddSuspension|AddSuspension( Double, Integer, Object, Object )]] {{APIComment|{{Template:ALTADataSet.AddSuspension3.Cmt}}}}
*[[ALTADataSet.AddFailureInterval|AddFailureInterval( Double, Double, Integer, Object() )]]      {{APIComment|{{Template:ALTADataSet.AddFailureInterval1.Cmt}}}}
*[[ALTADataSet.AddFailureInterval|AddFailureInterval( Double, Double, Integer, Object )]]        {{APIComment|{{Template:ALTADataSet.AddFailureInterval2.Cmt}}}}
*[[ALTADataSet.AddFailureInterval|AddFailureInterval( Double, Double, Integer, Object, Object )]] {{APIComment|{{Template:ALTADataSet.AddFailureInterval3.Cmt}}}}
*[[ALTADataSet.AddSuspensionInterval|AddSuspensionInterval( Double, Double, Integer, Object() )]]        {{APIComment|{{Template:ALTADataSet.AddSuspensionInterval1.Cmt}}}}
*[[ALTADataSet.AddSuspensionInterval|AddSuspensionInterval( Double, Double, Integer, Object )]]          {{APIComment|{{Template:ALTADataSet.AddSuspensionInterval2.Cmt}}}}
*[[ALTADataSet.AddSuspensionInterval|AddSuspensionInterval( Double, Double, Integer, Object, Object )]]  {{APIComment|{{Template:ALTADataSet.AddSuspensionInterval3.Cmt}}}}
*[[ALTADataSet.ClearDataSet|ClearDataSet]]                        {{APIComment|{{Template:ALTADataSet.ClearDataSet.Cmt}}}}


'''Analyze Data'''
==Method==
*[[ALTADataSet.Calculate|Calculate]] {{APIComment|{{Template:ALTADataSet.Calculate.Cmt}}}}
{| {{APITable}}
|-
| style="width: 200px;"|[[ALTADataSet.AddFailure|AddFailure]]||{{:ALTADataSet.AddFailure}}
|-
|[[ALTADataSet.AddFailureInterval|AddFailureInterval]]||{{:ALTADataSet.AddFailureInterval}}
|-
|[[ALTADataSet.AddStressDefinition|AddStressDefinition]]||{{:ALTADataSet.AddStressDefinition}}
|-
|[[ALTADataSet.AddStressProfile|AddStressProfile]]||{{:ALTADataSet.AddStressProfile}}
|-
|[[ALTADataSet.AddSuspension|AddSuspension]]||{{:ALTADataSet.AddSuspension}}
|-
|[[ALTADataSet.AddSuspensionInterval|AddSuspensionInterval]]||{{:ALTADataSet.AddSuspensionInterval}}
|-
|[[ALTADataSet.Calculate|Calculate]]||{{:ALTADataSet.Calculate}}
|-
|[[ALTADataSet.ClearDataSet|ClearDataSet]]||{{:ALTADataSet.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 ''[[ALTAAnalysisOptions Class|ALTAAnalysisOptions]]'') {{APIComment|{{Template:ALTADataSet.AnalysisSettings.Cmt}}}}
{| {{APITable}}
*GeneralSettings (as ''[[ALTAGeneralOptions Class|ALTAGeneralOptions]]'') {{APIComment|{{Template:ALTADataSet.GeneralSettings.Cmt}}}}
|-
*[[ALTADataSet.PlotUseStress|PlotUseStress( Integer )]] (as ''double'') {{APIComment|{{Template:ALTADataSet.PlotUseStress.Cmt}}}}
| style="width: 200px;"|AnalysisResults||Gets an '''[[ALTAAnalysisResults_Class|ALTAAnalysisResults]]''' object that represents the likelihood function value estimated from the accelerated life testing data analysis.
*[[ALTADataSet.StressRelation|StressRelation( Integer )]] (as ''[[ALTASolverLSR Enumeration|ALTASolverLSR]]'') {{APIComment|{{Template:ALTADataSet.StressRelation.Cmt}}}}
|-
 
|AnalysisSettings||Gets an '''[[ALTAAnalysisOptions_Class|ALTAAnalysisOptions]]''' object that represents the analysis settings for the accelerated life testing data analysis.
'''Analysis Results'''
|-
*FittedModel (as ''[[cModel Class|cModel]]'') {{APIComment|{{Template:ALTADataSet.FittedModel.Cmt}}}}
|Calculated||Indicates whether the data set has been analyzed. '''Boolean'''. Read only.  
*AnalysisResults (as ''[[ALTAAnalysisResults Class|ALTAAnalysisResults]]'') {{APIComment|{{Template:ALTADataSet.AnalysisResults.Cmt}}}}
|-
 
|DatasetName||Gets or sets the name of the data set. '''String'''. If no name has been specified, the default name is "Set 1."
'''Data Set Properties'''
|-
*DatasetName (as ''string'') {{APIComment|{{Template:ALTADataSet.DatasetName.Cmt}}}}
|FailureCount|| Gets the total number of failures in the data set. '''Integer'''.
*FailureCount (as ''integer'') {{APIComment|{{Template:WeibullDataSet.FailureCount.Cmt}}}} <!--Shared with WeibullDataSet-->
|-
*SuspensionCount (as ''integer'') {{APIComment|{{Template:WeibullDataSet.SuspensionCount.Cmt}}}} <!--Shared with WeibullDataSet-->
|FittedModel||Gets the '''[[cModel Class|cModel]]''' object that represents the fitted model of the accelerated life testing data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.  
*NumStresses (as ''integer'') {{APIComment|{{Template:ALTADataSet.NumStresses.Cmt}}}}
|-
 
|GeneralSettings||Gets an '''[[ALTAGeneralOptions_Class|ALTAGeneralOptions]]''' object that represents miscellaneous analysis settings.
== Events ==
|-
The [[ALTAEvents Class|ALTAEvents]] class contains {{Template:ALTAEvents_Class.Cmt}} <!--Comment shared with ALTADataSet_Class-->
|NumStresses||Gets the total number of stresses in the data set. '''Integer'''.
*[[ALTAEvents.Message|Message( ALTADataSet, String, String, Boolean )]] {{APIComment|{{Template:WeibullEvents.Message.Cmt}}}}
|-
*[[ALTAEvents.Question|Question( ALTADataSet, String, MsgBoxStyle, MsgBoxResult )]] {{APIComment|{{Template:WeibullEvents.Question.Cmt}}}}
|PlotUseStress(''Index'')||Gets or sets the use stress value for a particular stress for use in plots (not calculations). '''Double'''. The ''Index'' parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.  
*[[ALTAEvents.UpdateCalculationProgress|UpdateCalculationProgress( ALTADataSet, String, String, Double, Boolean, Long, Boolean ) ]]{{APIComment|{{Template:WeibullEvents.UpdateCalculationProgress.Cmt}}}}
|-
*[[ALTAEvents.ShowCalculationProgress|ShowCalculationProgress( ALTADataSet )]]{{APIComment|{{Template:WeibullEvents.ShowCalculationProgress.Cmt}}}}
|StressRelation(''Index'')||Gets or sets a value from the '''[[ALTASolverLSR_Enumeration|ALTASolverLSR]]''' enumeration, which specifies the stress transformation of a particular stress. The ''Index'' parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.
*[[ALTAEvents.HideCalculationProgress|HideCalculationProgress( ALTADataSet )]]{{APIComment|{{Template:WeibullEvents.HideCalculationProgress.Cmt}}}}
|-
 
|SuspensionCount||Gets the total number of suspensions in the data set. '''Integer'''.
== Usage Example ==
|-
This example demonstrates how to fit three failure times to a model and then use the model to calculate the reliability at a specified time. Full application examples are available at [[Synthesis_API_Reference#Application_Examples]].
|UseCalculationProgress||Indicates whether to display the progress bar while analyzing the data set. '''Boolean'''. Default value is true.
 
{{APIComment|'Initialize a new ALTADataSet object. See [[ALTADataSet Class|ALTADataSet]].}}
  Dim ADS As New ALTADataSet("DataSet1")
 
{{APIComment|'Set the analysis settings.}}
  ADS.AnalysisSettings.ModelType = ALTASolverModel.Arrhenius
  ADS.AnalysisSettings.Distribution = ALTASolverDistribution.Weibull
  ADS.AnalysisSettings.Analysis = ALTASolverMethod.MLE
  ADS.AnalysisSettings.UngroupGroupedData = False
  ADS.AnalysisSettings.SortBeforeCalculations = True
 
{{APIComment|'Set the general settings.}}
  ADS.GeneralSettings.AllowLargeBetaValues = False
  ADS.GeneralSettings.ImplementStressAtTheEndOfTheStep = False
 
{{APIComment|'Add a stress definition. See [[ALTADataSet.AddStressDefinition|AddStressDefinition]].}}
  ADS.AddStressDefinition("Temperature (K)", , 400)
 
{{APIComment|'Add failure times. See [[ALTADataSet.AddFailure|AddFailure]].}}
  ADS.AddFailure(248, 1, 406)
  ADS.AddFailure(164, 1, 416)
  ADS.AddFailure(92, 1, 426)
 
{{APIComment|'Fit failure times to the specified model. See [[ALTADataSet.Calculate|Calculate]].}}
  ADS.Calculate()
 
{{APIComment|'Get the reliability at 300 hours. See [[cModel Class]].}}
  Dim Rel As Double
  Rel = ADS.FittedModel.Reliability(300)

Revision as of 20:42, 19 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents an ALTA standard folio data sheet. The methods and properties in this class allow you to define a data set and fit a distribution and life-stress relationship to the data.

Constructor

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


Method

Name Description
AddFailure Adds a failure time to the data set.
AddFailureInterval Adds interval censored failures to the data set.
AddStressDefinition Adds a stress type to the data set.
AddStressProfile Adds a cProfile object, which represents a time-dependent stress profile, to the data set. Applies to the cumulative damage (CD) model only.
AddSuspension Adds suspensions to the data set.
AddSuspensionInterval Adds interval censored suspensions to the data set.
Calculate Fits a life distribution and life-stress relationship to the current data set, and creates a cModel object that represents the fitted model.
ClearDataSet Clears all data in the data set and removes the fitted model, if any.


Properties

Name Description
AnalysisResults Gets an ALTAAnalysisResults object that represents the likelihood function value estimated from the accelerated life testing data analysis.
AnalysisSettings Gets an ALTAAnalysisOptions object that represents the analysis settings for the accelerated life testing data analysis.
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 accelerated life testing data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.
GeneralSettings Gets an ALTAGeneralOptions object that represents miscellaneous analysis settings.
NumStresses Gets the total number of stresses in the data set. Integer.
PlotUseStress(Index) Gets or sets the use stress value for a particular stress for use in plots (not calculations). Double. The Index parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.
StressRelation(Index) Gets or sets a value from the ALTASolverLSR enumeration, which specifies the stress transformation of a particular stress. The Index parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.
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.
Retrieved from "https://www.reliawiki.com/index.php?title=ALTADataSet_Class&oldid=63414"