elphick.geomet.flowsheet.stream.Stream

class elphick.geomet.flowsheet.stream.Stream(*args, **kwargs)

__init__(*args, **kwargs)

Parameters:

• data – The input data

• name – The name of the sample

• moisture_in_scope – Whether the moisture is in scope. If False, only dry mass is processed.

• mass_wet_var – The name of the wet mass column

• mass_dry_var – The name of the dry mass column

• moisture_var – The name of the moisture column

• component_vars – The names of the chemical columns

• components_as_symbols – If True, convert the composition variables to symbols, e.g. Fe

• ranges – The range of valid data for each column in the data

• config_file – The configuration file

Methods

__init__(*args, **kwargs)
add(other[, name, include_supplementary_data])	Add two objects together
create_congruent_object(name[, ...])	Create an object with the same attributes
div(other[, name, include_supplementary_data])	Divide two objects
filter_by_index(index)	Update the data by index
from_mass_dataframe(mass_df[, mass_wet, ...])	Class method to create a MassComposition object from a mass dataframe.
plot_comparison(other[, color, ...])	Create an interactive parallel plot
plot_parallel([color, vars_include, ...])	Create an interactive parallel plot
plot_ternary(variables[, color, title])	Plot a ternary diagram
query(expr[, name])	Reduce the data by a query expression
random_int()
reset_index(index_name)
set_child_node(child)
set_nodes(nodes)
set_parent_node(parent)
split(fraction[, name_1, name_2, ...])	Split the object by mass
sub(other[, name, include_supplementary_data])	Subtract other from self
to_stream()
update_mass_data(value)
weight_average([group_by])

Attributes

aggregate
composition_columns
data
data_columns
mass_columns
mass_data
moisture_column
supplementary_columns
variable_map	A map from lower case standard names to the actual column names