tappy.tappy.analysis¶
- tappy.tappy.analysis(data_filename, def_filename=None, quiet=False, debug=False, outputts=False, outputxml='', ephemeris=False, rayleigh=1.0, print_vau_table=False, missing_data='ignore', linear_trend=False, remove_extreme=False, zero_ts=None, filter=None, pad_filters=None, include_inferred=True, xmlname='A port in a storm', xmlcountry='A man without a country', xmllatitude=0.0, xmllongitude=0.0, xmltimezone='0000', xmlcomments='No comment', xmlunits='m', xmldecimalplaces='full')¶
Traditional analysis with separately calculated nodal factors.
Constituent amplitude units are the same as the input heights. Constituent phases are based in the same time zone as the dates.
- Parameters:
data_filename (str) – The time-series of elevations to be analyzed. Can be a file name that is parsed with a companion definition file or a CSV, WDM, HDF5, or XLSX file. The options for each file type are listed in “tstoolbox read –help” on the command line or “help(tstoolbox.read) in Python.
def_filename (str, optional) – Contains the definition string to parse the input data.
quiet (bool, optional) – Print nothing to the screen.
debug (bool, optional) – Print debug messages.
outputts (bool, optional) – Output time series for each constituent.
ephemeris (bool, optional) – Print out ephemeris tables.
rayleigh (float, optional) – The Rayleigh coefficient is used to compare against to determine time series length to differentiate between two frequencies. [default: default]
missing_data (str, optional) – What should be done if there is missing data. One of: fail, ignore, or fill. [default: default]
linear_trend (bool, optional) – Include a linear trend in the least squares fit.
remove_extreme (bool, optional) – Remove values outside of 2 standard deviations before analysis.
zero_ts (str, optional) – Zero the input time series before constituent analysis by subtracting filtered data. One of: transform,usgs,doodson,boxcar
filter (str, optional) – Filter input data set with tide elimination filters. The -o outputts option is implied. Any mix separated by commas and no spaces: transform,usgs,doodson,boxcar
pad_filters (str, optional) – Pad input data set with values to return same size after filtering. Realize edge effects are unavoidable. One of [“tide”, “minimum”, “maximum”, “mean”, “median”, “reflect”, “wrap”]
include_inferred (bool, optional) – Do not incorporate any inferred constituents into the least squares fit.
print_vau_table (bool, optional) – For debugging - will print a table of V and u values to compare against Schureman.
outputxml (str, optional) – File name to output constituents as IHOTC XML format.
xmlname (str, optional) – Not used in analysis. Used ONLY to complete the XML file. Name of the station supplying the observations. [default: A port in a storm]
xmlcountry (str, optional) – Not used in analysis. Used ONLY to complete the XML file. Name of the country containing the station. Defaults to ‘A man without a country’.
xmllatitude (float, optional) – Not used in analysis. Used ONLY to complete the XML file. Latitude of the station. Defaults to 0.0.
xmllongitude (float, optional) – Not used in analysis. Used ONLY to complete the XML file. Longitude of the station. Defaults to 0.0.
xmltimezone (str, optional) – Not used in analysis. Used ONLY to complete the XML file. Time zone of the station. Defaults to ‘0000’.
xmlcomments (str, optional) – Not used in analysis. Used ONLY to complete the XML file. Station comments. Defaults to ‘No comment’.
xmlunits (str, optional) – Not used in analysis. Used ONLY to complete the XML file. Units of the observed water level. Defaults to ‘m’.
xmldecimalplaces (str, optional) – Not used in analysis. Used ONLY to complete the XML file. Format of the observed amplitude and phase. Default depends on length of analysis record. ‘full’ is the default and means that full accuracy, ‘ihotc’ is formatted according to IHOTC standard which severly limits the number of decimal places, and if an integer number lists the number of decimal places.
