darsia.SimpleFlash

class SimpleFlash(min_value_aq, max_value_aq, min_value_g, max_value_g, restoration=None)

Bases: object

Flash splitting a signal into aqueous and gas fractions by fixed bounds.

Constructor.

Methods

from_dict(data)	Create a SimpleFlash from a dictionary.
load(path)	Load the SimpleFlash parameters from a file.
save(path)	Save the SimpleFlash parameters to a file.
to_dict()	Convert the SimpleFlash parameters to a dictionary.
update([min_value_aq, max_value_aq, ...])	Update of internal parameters.

Attributes

min_value_aq	Minimum value.
max_value_aq	Maximum value.
min_value_g	Minimum value.
max_value_g	Maximum value.
restoration	Restoration object.

classmethod from_dict(data)

Create a SimpleFlash from a dictionary.

Parameters:

datadict

Dictionary representation of the SimpleFlash parameters.

classmethod load(path)

Load the SimpleFlash parameters from a file.

Parameters:

pathPath

The path to the file from which the parameters will be loaded.

Returns:

SimpleFlash

The loaded SimpleFlash instance.

save(path)

Save the SimpleFlash parameters to a file.

Parameters:

pathPath

The path to the file where the parameters will be saved.

to_dict()

Convert the SimpleFlash parameters to a dictionary.

Returns:

dict

Dictionary representation of the SimpleFlash parameters.

update(min_value_aq=None, max_value_aq=None, min_value_g=None, max_value_g=None)

Update of internal parameters.

Parameters:

min_value_aqfloat | None

Minimum value for aqueous phase.

max_value_aqfloat | None

Maximum value for aqueous phase.

min_value_gfloat | None

Minimum value for gas phase.

max_value_gfloat | None

Maximum value for gas phase.

max_value_aq

Maximum value.

max_value_g

Maximum value.

min_value_aq

Minimum value.

min_value_g

Minimum value.

restoration

Restoration object.