LocalRatingSet Class

Detailed Documentation

Example Usage

LocalRatingSet

LocalRatingSet objects are instances of rating sets in python. They can be retrieved by using CwmsDataStore objects and stored to and retrieved from DssDataStore objects. LocalRatingSet objects may also be serialized to and deserialized from text files in XML format.

Required Information

  • name: str (the rating specification identifier - even when retrieving from DssDataStore objects [1])

  • office: str (the CWMS office that owns the ratings)

  • method: str (must be "LAZY" (default) or "EAGER" - if "REFERENCE" is used with a CwmsDataStore object a LocalRatingSet object is retrieved)

Notes

Rating sets are collections of ratings with the same RatingSpecification ID. A rating set may have one or more ratings, each with its own effective time, and can be thought of as an irregluar time series of ratings.

Ratings (and thus rating sets) may have one or more independent parameters and one dependent parameter. Reverse rating is possible only with ratings with a single independent parameter.

All TableRating objects in LocalRatingSet objects retrieved with method="EAGER" have their ratings points populated on retrieval. This may load ratings points for effective times that will not be used in subsequent calls to rate(...) or reverse_rate(...).

All TableRatings objects in LocalRatingSet objects retrieved with method="LAZY" (or no method specified) do not have their rating points populated on retrieval. The ratings points for an effective time will be populated only when the specific rating is first used in a call to rate(...) or reverse_rate(...). Depending on the use case, this may substantially speed up the overall retrieval and use of the rating set.