fieldpy.stream_gauging.logged

Class Stage

Class to hold and process stage data.

self.data will have the following

Instance Methods

[hide private]

__init__(self, filenames, given_headers=['time', 'stage'])
Class to hold and process stage data. source code

apply_all_filters(self)
Applies all filters in the right order.

source code

set_stage2discharge_method(self, method)
Set a method to use to convert stage to discharge.

source code

check(self)
Does integrity checks, should be invoced at the end of __init__ of the children classes.

source code

Inherited from core.experiment_classes.CampbellCr1000: make_data, make_time

Inherited from core.extra_classes.TimeSeries: check_constant_sampling_interval, check_monotonically_inc_time, cut_time_series, filter_and_resample, get_ind, get_ind_as_slice, get_index_after, get_index_before, get_index_nearest, integrate, plot_date, plot_ts, time_filter_gauss

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__

Properties

[hide private]

Inherited from object: __class__

init(self, filenames, given_headers=`['time',` `'stage']`)
(Constructor)

source code

Class to hold and process stage data.

Parameters:

filenames (list of strings) - a list of TOA5 Campbell Cr1000 files in chronological order with the same data format.
given_headers (list of stings) - A list of header stings to be used instead of the ones given in the file header.

Overrides: object.__init__

Note:

Error checking is just marginal.
Masking record arrays seems a bit tricky here is what I found:
- http://thread.gmane.org/gmane.comp.python.numeric.general/34100/focus=34125
- but third creation method here seems to work: http://docs.scipy.org/doc/numpy/reference/maskedarray.generic.html#using-numpy-ma

>>> from fieldpy.core.stream_gauging.stream_gauging import *
>>> dir_ = 'test_files/stream_gauging/'
>>> fielns = ['TOA5_stage_1.dat','TOA5_stage_2.dat','TOA5_stage_3.dat']
>>> stage = Stage([dir_ + fl for fl in fielns], ['time', 'stage'])

check(self)

source code

Does integrity checks, should be invoced at the end of __init__ of the children classes.

Overrides: core.extra_classes.Data.check: (inherited documentation)

Class Stage

__init__(self, filenames, given_headers=['time', 'stage']) (Constructor)

check(self)

init(self, filenames, given_headers=`['time',` `'stage']`)
(Constructor)