Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| combine_per_component_area_energy (self, List[str] from_keys, str to) | |
| Combine the area and energy of multiple components into a single component. | |
| combine_per_component_area (self, List[str] from_keys, str to) | |
| Combine the area of multiple components into a single component. | |
| combine_per_component_energy (self, List[str] from_keys, str to) | |
| Combine the energy of multiple components into a single component. | |
| OutputStats | aggregate (self) |
| Aggregate the OutputStats objects in the list. | |
| "OutputStatsList" | aggregate_by (self, *str keys) |
| Aggregate the OutputStats objects in the list by a set of keys. | |
| List["OutputStatsList"] | split_by (self, *str keys) |
| Split the OutputStats objects in the list by a set of keys. | |
| clear_zero_energies (self) | |
| Remove components with zero energy. | |
| clear_zero_areas (self) | |
| Remove components with zero area. | |
Constructor & Destructor Documentation
◆ __init__()
| timeloopfe.v4.output_parsing.OutputStatsList.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
Member Function Documentation
◆ aggregate()
| OutputStats timeloopfe.v4.output_parsing.OutputStatsList.aggregate | ( | self | ) |
Aggregate the OutputStats objects in the list.
Returns: OutputStats: The aggregated OutputStats object.
◆ aggregate_by()
| "OutputStatsList" timeloopfe.v4.output_parsing.OutputStatsList.aggregate_by | ( | self, | |
| *str | keys ) |
Aggregate the OutputStats objects in the list by a set of keys.
OutputStats with equal values for the keys will be aggregated together. OutputStats with different values for the keys will be aggregated separately and returned as a list.
Args: keys (List[str]): The keys to aggregate by.
Returns: OutputStatsList: A list of aggregated OutputStats objects.
◆ clear_zero_areas()
| timeloopfe.v4.output_parsing.OutputStatsList.clear_zero_areas | ( | self | ) |
Remove components with zero area.
◆ clear_zero_energies()
| timeloopfe.v4.output_parsing.OutputStatsList.clear_zero_energies | ( | self | ) |
Remove components with zero energy.
◆ combine_per_component_area()
| timeloopfe.v4.output_parsing.OutputStatsList.combine_per_component_area | ( | self, | |
| List[str] | from_keys, | ||
| str | to ) |
Combine the area of multiple components into a single component.
Args: from_keys (List[str]): The keys of the components to combine. to (str): The key to combine the components into.
◆ combine_per_component_area_energy()
| timeloopfe.v4.output_parsing.OutputStatsList.combine_per_component_area_energy | ( | self, | |
| List[str] | from_keys, | ||
| str | to ) |
Combine the area and energy of multiple components into a single component.
Args: from_keys (List[str]): The keys of the components to combine. to (str): The key to combine the components into.
◆ combine_per_component_energy()
| timeloopfe.v4.output_parsing.OutputStatsList.combine_per_component_energy | ( | self, | |
| List[str] | from_keys, | ||
| str | to ) |
Combine the energy of multiple components into a single component.
Args: from_keys (List[str]): The keys of the components to combine. to (str): The key to combine the components into.
◆ split_by()
| List["OutputStatsList"] timeloopfe.v4.output_parsing.OutputStatsList.split_by | ( | self, | |
| *str | keys ) |
Split the OutputStats objects in the list by a set of keys.
Returns a list of OutputStatsList objects, where each OutputStatsList contains the OutputStats objects with the same values for the keys.
Args: keys (List[str]): The keys to split by.
Returns: List[OutputStatsList]: A list of OutputStatsList objects.
The documentation for this class was generated from the following file:
- timeloopfe/v4/output_parsing.py
Generated by
1.12.0