pyacs.gts.Sgts_methods package¶
Submodules¶
pyacs.gts.Sgts_methods.add_offsets_dates module¶
pyacs.gts.Sgts_methods.append module¶
pyacs.gts.Sgts_methods.common_mode module¶
- pyacs.gts.Sgts_methods.common_mode.common_mode(self, lref=[], detrend_method='detrend_median', method='median', center=True, verbose=True)[source]¶
calculates a common mode
- Parameters
lref – liste of site codes used to calculate the common mode
detrend_method – ‘detrend_median’ or ‘detrend’, method used to detrend the reference sites time series
method – method to calculate the common mode ‘median’ or ‘mean’
- Returns
a Sgts instance with filtered time series. This new instance has a _CMM time series for the common mode
- Note
time series are assumed to be daily time series
pyacs.gts.Sgts_methods.copy module¶
pyacs.gts.Sgts_methods.delts module¶
pyacs.gts.Sgts_methods.frame module¶
- pyacs.gts.Sgts_methods.frame.frame(self, frame=None, euler=None, w=None, verbose=False)[source]¶
Rotates the time series according to an Euler pole. User must provide either frame, euler or w.
- Parameters
frame – str, implemented values are ‘soam’,’nas’,’nazca’,’inca’,’nas_wrt_soam’,’inca_wrt_soam’.
euler – Euler values provided either as a string ‘euler_lon/euler_lat/euler_w’, a list [euler_lon,euler_lat,euler_w] or a 1D numpy array np.array([euler_lon,euler_lat,euler_w])
w – rotation rate vector in rad/yr, provided either as a string ‘wx/wy/wz’, a list [wx,wy,wz] or a 1D numpy array np.array([wx,wy,wz])
- Returns
the new Sgts instance in new frame
- Ref
All values for frames are from Nocquet et al., Nat Geosc., 2014.
pyacs.gts.Sgts_methods.gts module¶
- pyacs.gts.Sgts_methods.gts.gts(self, method, *args, **kwargs)[source]¶
apply a gts method to all Gts instance of the current Sgts object
- Parameters
method – Gts method to be applied as string
*arg –
arguments for the Gts method to be applied
**kwarg –
keyword arguments for the Gts method to be applied
:example : ts.gts(‘detrend’,periods=[2010.0,2013.0])
pyacs.gts.Sgts_methods.has_ts module¶
pyacs.gts.Sgts_methods.lGts module¶
pyacs.gts.Sgts_methods.lcode module¶
pyacs.gts.Sgts_methods.medvel module¶
- pyacs.gts.Sgts_methods.medvel.medvel(self, outdir=None, verbose=False)[source]¶
Automatic velocity estimates using median estimator. The code is adapted from the MIDAS approach (Blewitt et al., 2016).
medvel fills the velocity attribute of every Gts from the current Sgts instance.
returns the modified Sgts instance Optionally, if outdir option is provided, writes the results in outdir
- Param
outdir: output directory, default None
- Param
verbose: boolean, verbose mode
- Param
warning: output warning file
- Reference
Blewitt, G., Kreemer, C., Hammond, W. C., & Gazeaux, J. (2016). MIDAS robust trend estimator for accurate GPS station velocities without step detection. Journal of Geophysical Research: Solid Earth, 121(3), 2054-2068.
pyacs.gts.Sgts_methods.n module¶
pyacs.gts.Sgts_methods.read_gmt module¶
- pyacs.gts.Sgts_methods.read_gmt.read_gmt(self, gmt=True, verbose=False, vel=False)[source]¶
Reads a gmt psvelo file and populates lon and lat attributes for each Gts of Sgts
- Parameters
gmt – if True tries to read ‘/../stat/pyacs_void.gmt’, if a string then it is the gmt file to be read.
verbose – verbose mode
vel – boolean. If True, fills the .velocity attribute of every time series with the values read in the gmt file.
- Note
this method is always in place.
pyacs.gts.Sgts_methods.read_gts_conf module¶
- pyacs.gts.Sgts_methods.read_gts_conf.read_gts_conf(self, gts_conf_file, verbose=False)[source]¶
Reads a gts_conf_file implemented commands in the file are: #todo add_break [site] [date] # date is either [decyear] [doy year] [mday month year] apply_offset [site] [offset_north,offset_east,offset_up] [date] # offset applied is in mm, date is either [decyear] [doy year] [mday month year] remove_offset [site] [offset_north,offset_east,offset_up] [date] # offset removed is in mm, date is either [decyear] [doy year] [mday month year] #todo extract_periods [site] [date1,date2] # date is either [decyear] [doy year] [mday month year] #todo exclude_periods [site] [date1,date2] # date is either [decyear] [doy year] [mday month year] #todo remove_day [site] [date]
pyacs.gts.Sgts_methods.read_soln module¶
pyacs.gts.Sgts_methods.read_ts module¶
- pyacs.gts.Sgts_methods.read_ts.read_ts(self, ts_dir='.', verbose=True, name_filter='', add_key='', sites=[], lexclude=[], type=None, xyz=True)[source]¶
Reads time series, trying to guess the format. Current time series format supported are: pos, kenv, mb_file, cats, txyz (pyacs), track (NEU format for high rate)
- Parameters
ts_dir – directory of time series files
name_filter – string used to filter time series name ‘name_filter’
add_key – adds a string before site code
sites – list of site codes to be read. Any other will be discarded.
lexclude – list of sites to be excluded from reading
type – specifies the format of the time series files. Choose among [‘pos’, ‘kenv’, ‘mb_file’, ‘cats’, ‘txyz’, ‘track’ , ‘pride’,’pck’]
xyz – for pos files, reads the XYZ coordinates rather than dNEU. This is the default.
- Returns
an Sgts instance.
pyacs.gts.Sgts_methods.same_site module¶
- pyacs.gts.Sgts_methods.same_site.same_site(self, dc=10, in_place=True, verbose=False)[source]¶
Check that all gts in the current Sgts are actually the same site. If a given time series is found to be of two separate sites, then a new gts is added to the return Sgts instance.
param dc: critical distance to decide to split the time series param in_place: if True modify current Sgts, False retuen a new Sgts param verbose: verbose mode
return: a new Sgts instance
pyacs.gts.Sgts_methods.save_velocity module¶
pyacs.gts.Sgts_methods.sel_period module¶
- pyacs.gts.Sgts_methods.sel_period.sel_period(self, period, min_data=2, verbose=True)[source]¶
selects time series having some data for a given period
- Parameters
period – [start,end], start and end period as decimal years
min_data – minimum number of data for a time series to be kept
- Pram verbose
verbose mode
- Returns
a new Sgts instance
pyacs.gts.Sgts_methods.sel_rectangle module¶
pyacs.gts.Sgts_methods.show_map module¶
- pyacs.gts.Sgts_methods.show_map.show_map(self, bounds=None, highlight=[], tile=False, tile_provider='OpenTopoMap', figsize=(7, 9), show=True, save=False)[source]¶
- Parameters
self – Sgts instance
bounds – map bounds as list [min_lon,max_lon,min_lat,max_lat]
highlight – list of site code to be highlighted
tile – boolean. If True reads tiles from tile_provider. Requires internet connection. Default is False.
tile_provider – ‘OpenTopoMap’ or ‘OpenStreetMap.Mapnik’
- Returns
self
pyacs.gts.Sgts_methods.stat_site module¶
- pyacs.gts.Sgts_methods.stat_site.stat_site(self, lsite=[], lsite_file=None, verbose=False, save_dir=None)[source]¶
basic statistics about individual time series
- Parameters
lsite – list of selected sites for statistics
lsite_file – list of selected sites for statistics provided as a file
verbose – verbose mode
save_dir – directory where statistics files will be written