flasc.analysis.energy_ratio_input.EnergyRatioInput

flasc.analysis.energy_ratio_input.EnergyRatioInput#

class flasc.analysis.energy_ratio_input.EnergyRatioInput(df_list_in: List[DataFrame | FlascDataFrame], df_names: List[str], num_blocks: int = 10)[source]#

Bases: object

EnergyRatioInput class.

This class holds the structured inputs for calculating energy ratios

Methods

get_df

Get the concatenated dataframe.

resample_energy_table

Use the block column of an energy table to resample the data.
Parameters:

  • df_list_in (List[pd.DataFrame | FlascDataFrame])

  • df_names (List[str])

  • num_blocks (int)

get_df() → DataFrame[source]#

Get the concatenated dataframe.

Returns:

The concatenated dataframe

Return type:

pl.DataFrame

resample_energy_table(perform_resample: bool = True) → DataFrame[source]#

Use the block column of an energy table to resample the data.

Parameters:

perform_resample (bool) -- Boolean, if False returns original energy table. Defaults to True.

Returns:

A new energy table with (approximately)

the same number of rows as the original

Return type:

pl.DataFrame

Contents