CADETProcess.fractionation.Fractionator#
- class CADETProcess.fractionation.Fractionator(name, cycle_time, _lock)[source]#
Class for Chromatogram Fractionation.
This class is responsible for setting events for starting and ending fractionation, handling multiple chromatograms, and calculating various performance metrics.
- Attributes:
- nameString
Name of the fractionator, defaulting to ‘Fractionator’.
- performance_keyslist
Keys for performance metrics including mass, concentration, purity, recovery, productivity, and eluent consumption.
Methods
add_duration(name[, time])Register a new duration or time point of interest.
add_event(name, parameter_path, state[, ...])Add a new event that changes a parameter during the process.
add_event_dependency(dependent_event, ...[, ...])Create a dependency relationship between events.
add_fraction(fraction, target)Add Fraction to the FractionPool of target component.
add_fractionation_event(event_name, target, time)Add a fractionation event.
Validate the event configuration.
Ensure no simulateneous events are scheduled for a specific parameter and index.
Verify if all required parameters are set.
Ensure all indices are specified when a parameter isn't initialized.
initial_values([purity_required])Create events from chromatogram with minimum purity.
plot_events([x_axis_in_minutes, ax, ...])Plot parameter state as a function of time.
plot_fraction_signal([chromatogram, ...])Plot the signal without the waste fractions.
remove_duration(duration_name)Remove a specified duration or time point from tracking.
remove_event(evt_name)Remove a specified event from the event handler.
remove_event_dependency(dependent_event, ...)Remove a previously defined dependency between events.
reset()Reset the results when fractionation times are changed.
save(case_dir[, start, end])Save chromatogram and purity plots to a specified directory.
set_fractionation_state(chrom, state)Set fractionation states of Chromatogram.