Package fieldpy :: Package stream_gauging :: Module dilution_gauging :: Class Stage2Discharge
[hide private]
[frames] | no frames]

Class Stage2Discharge

source code


Class for holding all the dilution gauging experiments of one season, with the aim of providing stage discharge relations for a season.

Similar in intent to calibration.AllCalibrations in the sense that it unifies several dilution_gauging.DilutionGauging instances.

It will provide several stage to discharge functions:

Instance Methods [hide private]
 
__init__(self, list_of_dilutiongauging_inst, plot_yes=False)
Initialises the class with
source code
 
check(self)
No checks so far
source code
 
plot_comparsion(self)
plot a comparsion of all stage discharge relation
source code
numpy array or float
stage2dis_all_fn(self, stage, dilution_gaugings_to_average)
Returns a function which converts the stage into a discharge using a fit to all stage discharge mesurements.
source code

Inherited from core.extra_classes.Data: filter_by_freq, filter_low_pass, mask_if_true, mask_jumps, mask_jumps_one_dir, mask_value, pickle

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Instance Variables [hide private]

Inherited from core.extra_classes.Data: data, md

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, list_of_dilutiongauging_inst, plot_yes=False)
(Constructor)

source code 

Initialises the class with

Parameters:
Overrides: object.__init__

To Do: specify order of polyon for stage2dis

check(self)

source code 

No checks so far

Overrides: core.extra_classes.Data.check

stage2dis_all_fn(self, stage, dilution_gaugings_to_average)

source code 

Returns a function which converts the stage into a discharge using a fit to all stage discharge mesurements.

Parameters:
  • stage (numpy array or float) - the stage to convert into discharge
  • dilution_gaugings_to_average (list of int) - List of which gaugings of self.dilution_gaugings to use
Returns: numpy array or float
discharge