Skip to content

Commit b261280

Browse files
committed
attributes -> parameters
1 parent 4376c38 commit b261280

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

RATapi/outputs.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def __str__(self):
6565
class CalculationResults(RATResult):
6666
"""The goodness of fit from the Abeles calculation.
6767
68-
Attributes
68+
Parameters
6969
----------
7070
chiValues : np.ndarray
7171
The chi-squared value for each contrast.
@@ -82,7 +82,7 @@ class CalculationResults(RATResult):
8282
class ContrastParams(RATResult):
8383
"""The experimental parameters for each contrast.
8484
85-
Attributes
85+
Parameters
8686
----------
8787
scalefactors : np.ndarray
8888
The scalefactor values for each contrast.
@@ -108,7 +108,7 @@ class ContrastParams(RATResult):
108108
class Results:
109109
"""The results of a RAT calculation.
110110
111-
Attributes
111+
Parameters
112112
----------
113113
reflectivity : list
114114
The reflectivity curves for each contrast,
@@ -175,7 +175,7 @@ class PredictionIntervals(RATResult):
175175
- 3: the 65th percentile;
176176
- 4: the 95th percentile.
177177
178-
Attributes
178+
Parameters
179179
----------
180180
reflectivity : list
181181
The prediction interval data for reflectivity of each contrast.
@@ -195,7 +195,7 @@ class PredictionIntervals(RATResult):
195195
class ConfidenceIntervals(RATResult):
196196
"""The 65% and 95% confidence intervals for the best fit results.
197197
198-
Attributes
198+
Parameters
199199
----------
200200
percentile95 : np.ndarray
201201
The 95% confidence intervals for each fit parameter.
@@ -215,7 +215,7 @@ class ConfidenceIntervals(RATResult):
215215
class DreamParams(RATResult):
216216
"""The parameters used by the inner DREAM algorithm.
217217
218-
Attributes
218+
Parameters
219219
----------
220220
nParams : float
221221
The number of parameters used by the algorithm.
@@ -286,7 +286,7 @@ class DreamParams(RATResult):
286286
class DreamOutput(RATResult):
287287
"""The diagnostic output information from DREAM.
288288
289-
Attributes
289+
Parameters
290290
----------
291291
allChains : np.ndarray
292292
An ``nGenerations`` x ``nParams + 2`` x ``nChains`` size array,
@@ -337,7 +337,7 @@ class DreamOutput(RATResult):
337337
class NestedSamplerOutput(RATResult):
338338
"""The output information from the Nested Sampler (ns).
339339
340-
Attributes
340+
Parameters
341341
----------
342342
logZ : float
343343
The natural logarithm of the evidence Z for the parameter values.
@@ -365,7 +365,7 @@ class NestedSamplerOutput(RATResult):
365365
class BayesResults(Results):
366366
"""The results of a Bayesian RAT calculation.
367367
368-
Attributes
368+
Parameters
369369
----------
370370
predictionIntervals : PredictionIntervals
371371
The prediction intervals.

0 commit comments

Comments
 (0)