openmc.stats.Tabular

class openmc.stats.Tabular(x: Sequence[float], p: Sequence[float], interpolation: str = 'linear-linear', ignore_negative: bool = False)[source]

Piecewise continuous probability distribution.

This class is used to represent a probability distribution whose density function is tabulated at specific values with a specified interpolation scheme.

Parameters

  • x (Iterable of float) – Tabulated values of the random variable

  • p (Iterable of float) – Tabulated probabilities

  • interpolation ({'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log'}, optional) – Indicate whether the density function is constant between tabulated points or linearly-interpolated. Defaults to ‘linear-linear’.

  • ignore_negative (bool) – Ignore negative probabilities

Variables

  • x (numpy.ndarray) – Tabulated values of the random variable

  • p (numpy.ndarray) – Tabulated probabilities

  • interpolation ({'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log'}, optional) – Indicate whether the density function is constant between tabulated points or linearly-interpolated.

classmethod from_xml_element(elem: Element)[source]

Generate tabular distribution from an XML element

Parameters

elem (lxml.etree._Element) – XML element

Returns

Tabular distribution generated from XML element

Return type

openmc.stats.Tabular

integral()[source]

Return integral of distribution

New in version 0.13.1.

Returns

Integral of tabular distrbution

Return type

float

mean()[source]

Compute the mean of the tabular distribution

normalize()[source]

Normalize the probabilities stored on the distribution

sample(n_samples: int = 1, seed: Optional[int] = None)[source]

Sample the univariate distribution

Parameters

  • n_samples (int) – Number of sampled values to generate

  • seed (int or None) – Initial random number seed.

Returns

A 1-D array of sampled values

Return type

numpy.ndarray

to_xml_element(element_name: str)[source]

Return XML representation of the tabular distribution

Parameters

element_name (str) – XML element name

Returns

element – XML element containing tabular distribution data

Return type

lxml.etree._Element