smash.SignResult#

class smash.SignResult[source]#

Represents signatures computation result.

See also

Model.signatures

Compute continuous or/and flood event signatures of the Model.

Notes

This class is essentially a subclass of dict with attribute accessors.

Attributes:
contdict

Continuous signatures. The keys are

  • ‘obs’: a dataframe representing observation results.

  • ‘sim’: a dataframe representing simulation results.

The column names of both dataframes consist of the catchment code and studied signature names.

eventdict

Flood event signatures. The keys are

  • ‘obs’: a dataframe representing observation results.

  • ‘sim’: a dataframe representing simulation results.

The column names of both dataframes consist of the catchment code, the season that event occurrs, the beginning/end of each event and studied signature names.

Methods

clear()

copy()

fromkeys(iterable[, value])

Create a new dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

items()

keys()

pop(key[, default])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

setdefault(key[, default])

Insert key with a value of default if key is not in the dictionary.

update([E, ]**F)

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()