CADETProcess.solution.slice_solution_front

CADETProcess.solution.slice_solution_front#

CADETProcess.solution.slice_solution_front(solution_original: SolutionIO, min_percent: float | None = 0.02, max_percent: float | None = 0.98, use_max_slope: bool | None = False, return_indices: bool | None = False) SolutionIO | tuple[SolutionIO, int, int][source]#

Slice the front of a given solution.

Parameters:
solution_originalSolutionIO

The Solution object to slice.

min_percentOptional[float]

Minimum percentage of the peak height to consider. Default is 0.02.

max_percentOptional[float]

Maximum percentage of the peak height to consider. Default is 0.98.

use_max_slopeOptional[bool]

If True, cut use the maximum slope as end. Default if False.

return_indicesOptional[bool]

If True, also return the start end end indices of the front. Default if False.

Returns:
SolutionIO or tuple[SolutionIO, int, int]

The sliced SolutionIO object. If return_indices is True, also returns the start and end indices of the slice.