openmc.SurfaceFilter¶

class openmc.SurfaceFilter(bins, filter_id=None)[source]¶

Bins particle currents on Mesh surfaces.

Parameters:	bins (Iterable of Integral) – Indices corresponding to which face of a mesh cell the current is crossing. filter_id (int) – Unique identifier for the filter
Variables:	bins (Iterable of Integral) – Indices corresponding to which face of a mesh cell the current is crossing. id (int) – Unique identifier for the filter num_bins (Integral) – The number of filter bins

get_pandas_dataframe(data_size, stride, **kwargs)[source]¶

Builds a Pandas DataFrame for the Filter’s bins.

This method constructs a Pandas DataFrame object for the filter with columns annotated by filter bin information. This is a helper method for Tally.get_pandas_dataframe().

Parameters:	data_size (int) – The total number of bins in the tally corresponding to this filter stride (int) – Stride in memory for the filter
Returns:	A Pandas DataFrame with a column of strings describing which surface the current is crossing and which direction it points. The number of rows in the DataFrame is the same as the total number of bins in the corresponding tally, with the filter bin appropriately tiled to map to the corresponding tally bins.
Return type:	pandas.DataFrame