swmm.pandas.output.Structure¶
- class Structure(outfile, link, node)[source]¶
A class that represents a particular system structure that may be represented by multiple model elements. The outputs from each element are combined into a single time series for analysis as if they are a single structure.
The structure class can be used to summarize flow and flooding at one or more model elements from a particular simulation. Parse link flow time series into discrete events with the flowEvents method, or summarize flooding events with the floodEvents method.
- Parameters:
- outfile: swmm.pandas.Output
The swmm-pandas outfile object containing the model elements.
- link: Union[str, Sequence[str]]
The list of links that belong to the structure.
- node: Union[str, Sequence[str]]
The list of nodes that below to the structure.
Methods
__init__(outfile, link, node)floodEvents([inter_event_period, thresholdFood])Bins flooding data into discrete events based on an inter-event period and threshold flooding rate.
flowEvents([inter_event_period, ...])Bin flow data into discrete events based on an inter-event period and threshold flow rate.
Attributes
Returns a pandas DataFrame with the flood rates of each node in the structure
Returns a pandas DataFrame with the flow rates of each link in the structure
The Output object from which this structure is derived
A list of the link(s) that belong to this structure
A list of the node(s) that belong to this structure