Functionalities

The Jarkus Analysis Toolbox provides many functionalities. Here, all available modules are explained per category.

Geometric functions

Provides basic geometric functions that execute calculations based on the coastal profile.

JAT.Geometric_functions.find_intersections(elevation, crossshore, y_value)

Find cross-shore location of intersection between profile and horizontal line at a fixed elevation.

Parameters
  • elevation (np.array) – np.array containing the elevation of the coastal profile in meters.

  • crossshore (np.array) – np.array containing the crossshore location in meters.

  • y_value (float) – Elevation of the horizontal line in meters.

Returns

intersection_x: Cross-shore location of the intersection between the coastal profile and horizontal line.

Return type

int

JAT.Geometric_functions.get_gradient(elevation, seaward_x, landward_x)

Find gradient of a profile between two points

The gradient of a coastal profile is determined by finding the slope of the line of best fit along the elevation between a landward and seaward boundary.

Parameters
  • elevation (np.array) – np.array containing the elevation of the coastal profile in meters

  • seaward_x (float or int) – Cross-shore seaward boundary

  • landward_x (float or int) – Cross-shore landward boundary

Returns

gradient: slope of the best fit line

Return type

float

JAT.Geometric_functions.get_volume(elevation, seaward_x, landward_x)

Determine volume under coastal profile between two two points

The volume of the coastal profile between a landward and seaward boundary is determined by integrating over the surface beneath the coastal profile between those two points.

Parameters
  • elevation (np.array) – np.array containing the elevation of the coastal profile in meters

  • seaward_x (float or int) – Cross-shore seaward boundary

  • landward_x (float or int) – Cross-shore landward boundary

Returns

volume: surface under the graph in m^2. Can be interpreted as m^3 by assuming the profile is 1 m wide.

Return type

float

Jarkus Analysis Toolbox

Includes the most important functionalities of the JAT including retrieving data and extracting profile dimensions

class JAT.Jarkus_Analysis_Toolbox.Extraction(data, config)

Extracting characteristic parameters from coastal profiles.

This class provides the functionalities to extract the characteristic parameters requested by the user from transects of the jarkus dataset. Additionally, it provides functions to post-process the outcome of the extraction.

get_active_profile_gradient(trsct_idx)

Extract the gradient of the active profile (Active_profile_gradient).

The gradient of the active profile is determined by finding the slope of the line of best fit along the coastal profile between the seaward active profile boundary and the landward boundary between the marine and aeolian zone (BMA).

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_active_profile_volume(trsct_idx)

Extract the volume of the active profile (Active_profile_volume).

The volume of the active profile is determined by finding the surface under the coastal profile between the seaward active profile boundary and the landward boundary between the marine and aeolian zone (BMA).

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_all_dimensions()

Extracts all requested characteristic parameters for all requested years and transects.

Checks whether the saving directory is in place and proceeds to go through all requested transects. Per characteristic parameter it is checked whether it was requested, and, if so, the values for all requested years are extracted. Ultimately, per transect a dataframe is saved that includes the values of all requested characteristic parameters for all years at that location.

get_beach_gradient_der(trsct_idx)

Extract the gradient of the beach (Beach_gradient_der).

The gradient of the beach is determined by finding the slope of the line of best fit along the coastal profile between the fixed mean sea level and the second derivative dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_beach_gradient_fix(trsct_idx)

Extract the gradient of the beach (Beach_gradient_fix).

The gradient of the beach is determined by finding the slope of the line of best fit along the coastal profile between the fixed mean sea level and the fixed dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_beach_gradient_var(trsct_idx)

Extract the gradient of the beach (Beach_gradient_var).

The gradient of the beach is determined by finding the slope of the line of best fit along the coastal profile between the variable mean sea level and the fixed dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_beach_width_der()

Extract the width of the beach (Beach_width_der).

The width of the beach is determined by calculating the cross-shore distance between the fixed mean sea level and the dune toe location based on the second derivative method.

get_beach_width_der_var()

Extract the width of the beach (Beach_width_der_var).

The width of the beach is determined by calculating the cross-shore distance between the variable mean sea level and the dune toe location based on the second derivative method.

get_beach_width_fix()

Extract the width of the beach (Beach_width_fix).

The width of the beach is determined by calculating the cross-shore distance between the fixed mean sea level and the fixed dune toe location.

get_beach_width_var()

Extract the width of the beach (Beach_width_var).

The width of the beach is determined by calculating the cross-shore distance between the variable mean sea level and the fixed dune toe location.

get_dataframe_per_dimension()

Creates and saves a dataframe per characteristic parameter from the dataframes with all requested characteristic parameters per transect.

get_dune_front_gradient_prim_der(trsct_idx)

Extract the gradient of the primary dune front (Dunefront_gradient_prim_der).

The gradient of the dune front is determined by finding the slope of the line of best fit along the coastal profile between the primary dune top and the derivative dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_dune_front_gradient_prim_fix(trsct_idx)

Extract the gradient of the primary dune front (Dunefront_gradient_prim_fix).

The gradient of the dune front is determined by finding the slope of the line of best fit along the coastal profile between the primary dune top and the fixed dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_dune_front_gradient_sec_der(trsct_idx)

Extract the gradient of the secondary dune front (Dunefront_gradient_sec_der).

The gradient of the dune front is determined by finding the slope of the line of best fit along the coastal profile between the secondary dune top and the derivative dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_dune_front_gradient_sec_fix(trsct_idx)

Extract the gradient of the secondary dune front (Dunefront_gradient_sec_fix).

The gradient of the dune front is determined by finding the slope of the line of best fit along the coastal profile between the secondary dune top and the fixed dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_dune_front_width_prim_der()

Extract the width of the primary dune front (Dunefront_width_prim_der).

The width of the primary dune front is determined by calculating the cross-shore distance between the cross-shore location of the primary dune top and the derivative dune toe location.

get_dune_front_width_prim_fix()

Extract the width of the primary dune front (Dunefront_width_prim_fix).

The width of the primary dune front is determined by calculating the cross-shore distance between the cross-shore location of the primary dune top and the fixed dune toe location.

get_dune_front_width_sec_der()

Extract the width of the secondary dune front (Dunefront_width_sec_der).

The width of the secondary dune front is determined by calculating the cross-shore distance between the cross-shore location of the secondary dune top and the derivative dune toe location.

get_dune_front_width_sec_fix()

Extract the width of the secondary dune front (Dunefront_width_sec_fix).

The width of the secondary dune front is determined by calculating the cross-shore distance between the cross-shore location of the secondary dune top and the fixed dune toe location.

get_dune_toe_derivative(trsct_idx)

Extract the elevation (Dunetoe_y_der) and cross-shore location (Dunetoe_x_der) of the dune toe based on the second derivative method [3].

The dune toe elevation is extracted from the repository where the work of Diamantidou et al. [3] is saved. First, the method selects part of the coastal profile. This selection is between the landward boundary (get_landward_point_derivative) and the variable MHW. Then, the first and second derivative of this part of the coastal profile is calculated. The most seaward location where the first derivative is lower than 0.001 and the second derivative is lower than 0.01 is selected as the dune toe [3].

Parameters

trsct_idx (index of the transect necessary to extract the elevation of the profiles.) –

3

Diamantidou, E., Santinelli, G., Giardino, A., Stronkhorst, J., & de Vries, S. “An Automatic Procedure for Dune toe Position Detection: Application to the Dutch Coast.” Journal of Coastal Research, 36(3)(2020): 668-675. https://doi.org/10.2112/JCOASTRES-D-19-00056.1

get_dune_toe_fixed(trsct_idx)

Extract the cross-shore location of the dune toe (Dunetoe_x_fix).

The dune toe is defined as a fixed, user-defined elevation (default = +3 m). The intersections between this elevation and the coastal profile are determined. Then, the cross-shore location of the most seaward intersection is selected as the dune toe.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_dune_toe_pybeach(trsct_idx)

Extract the elevation (Dunetoe_y_pybeach) and cross-shore location (Dunetoe_x_pybeach) of the dune toe based on pybeach machine learning method 7.

Pybeach provides three different pre-trained machine learning models (barrier-island, wave-embayed and mixed) that can extract the dune toe location. Here, the user can define which model to use (default = ‘mixed’) These models were based on the identification of the dune toe by experts. To make the applicaiton of the pybeach machine learning method comparable to the second derivative method a similar reduction of the coastal profile (with a landward and seaward boundary) is executed.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

7

Beuzen, Tomas. “pybeach: A Python package for extracting the location of dune toes on beach profile transects.” Journal of Open Source Software 4(44) (2019): 1890. https://doi.org/10.21105/joss.01890

get_dune_volume_der(trsct_idx)

Extract the dune volume (DuneVol_der).

The dune volume is determined by finding the surface under the coastal profile between the primary dune top and the derivative dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_dune_volume_fix(trsct_idx)

Extract the dune volume (DuneVol_fix).

The dune volume is determined by finding the surface under the coastal profile between the primary dune top and the fixed dune toe location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_foreshore_gradient(trsct_idx)

Extract the gradient of the foreshore (Foreshore_gradient).

The gradient of the foreshore is determined by finding the slope of the line of best fit along the coastal profile between the seaward foreshore boundary and the landward boundary between the marine and aeolian zone (BMA).

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_foreshore_volume(trsct_idx)

Extract the volume of the foreshore (Foreshore_volume).

The foreshore volume is determined by finding the surface under the coastal profile between the seaward foreshore boundary and the landward boundary between the marine and aeolian zone (BMA).

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_intertidal_gradient_fix(trsct_idx)

Extract the gradient of the intertidal area (Intertidal_gradient_fix).

The gradient of the intertidal area is determined by finding the slope of the line of best fit along the coastal profile between the fixed mean low water and the fixed mean high water.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_intertidal_volume_fix(trsct_idx)

Extract the volume of the intertidal area (Intertidal_volume_fix).

The intertidal area volume is determined by finding the surface under the coastal profile between the fixed mean low water and the fixed mean high water.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_intertidal_volume_var(trsct_idx)

Extract the volume of the intertidal area (Intertidal_volume_var).

The intertidal area volume is determined by finding the surface under the coastal profile between the variable mean low water and the variable mean high water.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_intertidal_width_fixed()

Extract the width of the intertidal area (Intertidal_width_fix).

The width of the intertidal area is determined by calculating the cross-shore distance between the fixed mean low water and the fixed mean high water.

get_intertidal_width_variable()

Extract the width of the intertidal area (Intertidal_width_var).

The width of the intertidal area is determined by calculating the cross-shore distance between the variable mean low water and the variable mean high water.

get_landward_point_bma(trsct_idx)

Extract the cross-shore location of the landward boundary based on the boundary between the marine and aeolian zone (Landward_x_bma) [4].

The landward boundary is defined as a fixed, user-defined elevation (default = +2 m). The intersections between this elevation and the coastal profile are determined. Then, the cross-shore location of the most seaward intersection is selected as the landward boundary.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

4

De Vries, S., de Schipper, M., Stive, M., & Ranasinghe, R. “Sediment exchange between the sub-aqeous and sub-aerial coastal zones.” Coastal Engineering. 2 (2010).

get_landward_point_derivative(trsct_idx)

Extract the cross-shore location of the landward boundary based on steps in the second derivative method (Landward_x_der) [3].

The landward boundary is determined by finding the peaks with a prominence larger than a fixed threshold (default = +2.4 m). If peaks are found and those peaks are larger than a user-defined elevation (default = 6.0), the cross-shore location of the intersection of this elevation with the coastal profile is the landward boundary. Otherwise, the peaks above the peaks threshold (variable MHW + prominence threshold) are selected and the most seaward selected peak is the landward boundary. If none of these selection cannot be applied a NaN value is inserted. This function uses scipy.signal.find_peaks [1]. The prominence of a peak measures how much a peak stands out from the surrounding baseline of the signal and is defined as the vertical distance between the peak and its lowest contour line [2].

Parameters

trsct_idx (index of the transect necessary to extract the elevation of the profiles.) –

3

Diamantidou, E., Santinelli, G., Giardino, A., Stronkhorst, J., & de Vries, S. “An Automatic Procedure for Dune toe Position Detection: Application to the Dutch Coast.” Journal of Coastal Research, 36(3)(2020): 668-675. https://doi.org/10.2112/JCOASTRES-D-19-00056.1

1

https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.find_peaks.html#scipy.signal.find_peaks

2

https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.peak_prominences.html#scipy.signal.peak_prominences

get_landward_point_variance(trsct_idx)

Extract the cross-shore location of the landward boundary based on variance (Landward_x_variance).

The landward boundary is determined by calculating the variance of the elevation of a transect location throughout all available years. Stable points are located based on where the variance of the elevation through time is below a user-defined threshold (default = 0.1). The stable points landward of the primary dune top are filtered out and the cross-shore location and elevation of the most seaward stable point is are selected as the landward boundary.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_mean_high_water_fixed(trsct_idx)

Extract the cross-shore location of mean high water (MHW_x_fix).

The mean high water is defined as a fixed, user-defined elevation (default = + 1 m). The intersections between this elevation and the coastal profile are determined. Then, intersections that are further than 250 m landward of the location of the mean sea level (MSL_x) are excluded. This filtering is necessary to make sure landward intersections behind the dunes are not selected as the MHW location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_mean_high_water_variable(trsct_idx)

Extract the elevation (MHW_y_var) and cross-shore location (MHW_x_var) of mean low water.

The mean high water is defined as a spatially variable elevation. This elevation is provided per transect location in the jarkus database (determined with tidal modeling). The intersections between this elevation and the coastal profile are determined. Then, intersections that are further than 250 m landward of the location of the mean sea level (MSL_x) are excluded. This filtering is necessary to make sure landward intersections behind the dunes are not selected as the MHW location. Both the cross-shore location and variable elevation are saved. Note, that the spatially variable elevation is not variable in time, so each transect has a constant MHW elevation assigned that is constant throughout the years.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_mean_low_water_fixed(trsct_idx)

Extract the cross-shore location of mean low water (MLW_x_fix).

The mean low water is defined as a fixed, user-defined elevation (default = -1 m). The intersections between this elevation and the coastal profile are determined. Then, intersections that are further than 250 m seaward of the location of the mean sea level (MSL_x) are excluded. This filtering is necessary to make sure seaward intersections caused by for instance the presence of shoals are not selected as the MLW location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_mean_low_water_variable(trsct_idx)

Extract the elevation (MLW_y_var) and cross-shore location (MLW_x_var) of mean low water.

The mean low water is defined as a spatially variable elevation. This elevation is provided per transect location in the jarkus database (determined with tidal modeling). The intersections between this elevation and the coastal profile are determined. Then, intersections that are further than 250 m seaward of the location of the mean sea level (MSL_x) are excluded. This filtering is necessary to make sure seaward intersections caused by for instance the presence of shoals are not selected as the MLW location. Both the cross-shore location and variable elevation are saved. Note, that the spatially variable elevation is not variable in time, so each transect has a constant MLW elevation assigned that is constant throughout the years.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_mean_sea_level(trsct_idx)

Extract the cross-shore location of mean sea level (MSL_x).

The mean sea level is defined as a fixed, user-defined elevation (default = 0 m). The intersections between this elevation and the coastal profile are determined. The most seaward intersection is selected as the cross-shore location if no primary dune top is available. Otherwise, all intersections landward of the primary dune top are filtered out. Then, if the distance between the most seaward and landward intersection is equal or smaller than 100 m the most seaward intersection is selected as the cross-shore MSL location. Otherwise, if the distance is larger than 100 m, only the intersections 100 m landward of the most seaward intersection are selected. Of this selection, the most seaward intersection is selected as the cross-shore MSL location. This filtering is necessary to make sure landward intersections behind the dunes and seaward intersections due to the presence of shoals are not selected as the MSL location.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_mean_sea_level_variable()

Extract the cross-shore mean sea level location (MSL_x_var) based on the variable mean high and low water.

The mean sea level location is determined by calculating the middle point between the cross-shore location of the variable mean high water and the variable mean low water.

get_primary_dune_top(trsct_idx)

Extract the primary dune top height (DuneTop_prim_y) and cross-shore location (DuneTop_prim_x).

The primary dune top is defined as the most seaward dune top that has a height that is larger than a user-defined threshold (default = 5 m) and a prominence that is larger than a user-defined value (default = 2.0). This function uses scipy.signal.find_peaks [1]. The prominence of a peak measures how much a peak stands out from the surrounding baseline of the signal and is defined as the vertical distance between the peak and its lowest contour line [2].

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

1

https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.find_peaks.html#scipy.signal.find_peaks

2

https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.peak_prominences.html#scipy.signal.peak_prominences

get_requested_variables()

Retrieve all variables that are related to the requested characteristic parameters

Returns

variables_req: List of all variable that are related to the requested characteristic parameters as included in the configuration file

Return type

list

get_seaward_point_activeprofile(trsct_idx)

Extract the cross-shore location of the seaward active profile boundary (Seaward_x_AP).

The seaward boundary is defined as a fixed, user-defined elevation (default = -8 m). The intersections between this elevation and the coastal profile are determined. Then, the cross-shore location of the most seaward intersection is selected as the seaward boundary.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_seaward_point_doc(trsct_idx)

Extract the cross-shore location (Seaward_x_DoC) of the depth of closure based on the method of Hinton [5].

Approximation of the depth of closure below a user-defined minimum (default = -5.0 m) (Seaward_x_mindepth) where the standard deviation of the elevation through time is below a user-defined value (default = 0.25) for at least a user-defined length (default = 200m), based on the method by Hinton [5].

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

5

Hinton, Claire L. Decadal morphodynamic behaviour of the Holland shoreface. Diss. Middlesex University, 2000. https://eprints.mdx.ac.uk/id/eprint/6601

6

Zwarenstein Tutunji, Nicha. “Classification of coastal profile development in the Hoogheemraadschap Hollands Noorderkwartier area: Using advanced data analysis techniques.” (2021).

get_seaward_point_foreshore(trsct_idx)

Extract the cross-shore location of the seaward foreshore boundary (Seaward_x_FS).

The seaward boundary is defined as a fixed, user-defined elevation (default = -4 m). The intersections between this elevation and the coastal profile are determined. Then, the cross-shore location of the most seaward intersection is selected as the seaward boundary.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

get_secondary_dune_top(trsct_idx)

Extract the secondary dune top height (DuneTop_sec_y) and cross-shore location (DuneTop_sec_x).

The secondary dune top is defined as the most seaward dune top that has a height that is larger than a user-defined threshold (default = 3 m) and a prominence that is larger than a user-defined value (default = 0.5) and is located seaward of the primary dune top. This function uses scipy.signal.find_peaks [1]. The prominence of a peak measures how much a peak stands out from the surrounding baseline of the signal and is defined as the vertical distance between the peak and its lowest contour line [2]. The goal of this function is to be able to identify embryo dune formation.

Parameters

trsct_idx (int) – index of the transect necessary to extract the elevation of the profiles.

1

https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.find_peaks.html#scipy.signal.find_peaks

2

https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.peak_prominences.html#scipy.signal.peak_prominences

normalize_dimensions()

Normalize the cross-shore location values of all requested characteristic parameters

Normalization of the cross-shore locations is done to make cross-shore values between transects comparable. The normalization is executed by subtracting a normalization value from the value of each year of a characteristic parameter. This function provides the option to apply a normalization based on the mean of all the years available for a transect. Additionally, a normalization based on the value of a fixed user-defined year is available. The normalized cross-shore locations are saved as a dataframe.

class JAT.Jarkus_Analysis_Toolbox.Transects(config)

Loading and plotting transects.

This class provides the functionalities to retrieve the jarkus dataset and filter out the years and locations requested by the user. This includes determining whether the user defined request is available. Additionally, the elevation of each requested transect can be saved and plotted to provide easy access for analysis, and the conversion of the transect number to the alongshore kilometer is provided.

get_availability(config)

Getting available years and transects

This function executes the get_years_filtered and get_transects_filtered functions based on a configuration file containing the requested years and transects.

Parameters

config (dict) – The configuration file that contains the user-requested years and transects

get_conversion_dicts()

Create conversion from transect number to alongshore meter and vice versa

For each transect number in the jarkus dataset the alongshore kilometer is calculated. A dictionary is created that relates each transect number to its alongshore kilometer. Additionally, a dictionary is created that does the reverse.

Returns

conversion_ids2alongshore: does the conversion from transect number to alongshore meter

conversion_alongshore2ids: does the conversion from alongshore meter to transect number

Return type

dict

get_transect_plot(config)

Save plot with all coastal profiles for each requested transect

For each requested transect a quickplot is created and saved (as png and picle file) that shows all the requested years. The colors in the plot go from the start year in red to the end year in blue. Currently the axes are set automatically but this can be changed to user-defined limits in the future, which is mostly relevant for single transect plotting.

Parameters

config (dict) – The configuration file that contains the user-requested years and transects, reference to the jarkus dataset and the save locations.

get_transects_filtered(transects)

Filtering requested transects

It is determined what type of request is made and which transects are associated with this request. Then all transects in the jarkus dataset are extracted and compared to the user-requested years. Only the available (requested) years and their indices are retained.

Parameters

transects (dict) – Part of the configuration file that includes which type of transects are requested (single, multiple, range or all) and (if applicable) which transects are associated with this request.

get_years_filtered(start_yr, end_yr)

Filtering requested years

All years in the jarkus dataset are extracted and compared to the user-requested years. Only the available (requested) years and their indices are retained.

Parameters
  • start_yr (int) – Starting year of the user-requested period

  • end_yr (int) – Ending year of the user-requested period

save_elevation_dataframes(config)

Save elevation of all years for each transect as a dataframe

The elevation and corresponding cross-shore location of each requested year and requested transect location are saved as a dataframe. Note that each resulting file contains the profiles for all requested years of one requested transect. The function provides the option to use a filter that leaves out profiles when there is no elevation data present between a certain minimum and maximum elevation. This can, for instance, be useful when only the foreshore is studied and all transects that do not have elevation data in this region are redundant. The user-defined values for filter1 are included in the configuration file. Currently this filter does not have an effect on the extraction of the characteristic parameters because these are determined based on the elevation that is directly extracted from the jarkus dataset. Therefore, the default setting for filter1 is that is it not applied (config[‘user defined’][‘filter1’][‘apply’]=False), but this could be changed in the future.

Parameters

config (dict) – The configuration file that contains the user-requested years and transects, reference to the jarkus dataset, the filter1 settings and the save locations.

Filtering functions

Provides functions that allow filtering of the extracted characteristic parameters.

JAT.Filtering_functions.availability_locations_filter(config, dimension)

Filter out transects based on data availability.

Filter out transects that have a data availability that is lower than the user-defined threshold.

Parameters
  • config (dict) – configuration file that includes the user defined availability threshold in percentage (filter2, locations)

  • dimension (pd.dataframe) – dataframe containing the values of a characteristic parameter through time and more multiple transect locations.

Returns

dimension_filt: dataframe containing the values of a characteristic parameter where filtered transects have been removed.

Return type

pd.dataframe

JAT.Filtering_functions.availability_years_filter(config, dimension)

Filter out years based on data availability.

Filter out years that have a data availability that is lower than the user-defined threshold.

Parameters
  • config (dict) – configuration file that includes the user defined availability threshold in percentage (filter2, years)

  • dimension (pd.dataframe) – dataframe containing the values of a characteristic parameter through time and for multiple transect locations.

Returns

dimension_filt: dataframe containing the values of a characteristic parameter where filtered years have been removed.

Return type

pd.dataframe

JAT.Filtering_functions.locations_filter(dimension, filter_file)

Filter out user-defined transects.

Filter out locations that are specified by the user from a dataframe of a characteristic parameter. Default settings filter out locations like the Hondsbossche Dunes and Maasvlakte, redundant transects at the outer edges of the Wadden Islands, and dams in Zeeland.

Parameters
  • dimension (pd.dataframe) – dataframe containing the values of a characteristic parameter through time and more multiple transect locations.

  • filter_file (dict) – Includes a numbered list of sections that should be excluded. The first transect number represents the start of the section, the second transect number the end.

Returns

dimension_filt: dataframe containing the values of a characteristic parameter where filtered transects have been removed.

Return type

pd.dataframe

JAT.Filtering_functions.nourishment_filter(config, dimension)

Split characteristic parameter values into nourished and not nourished transects.

Parameters
  • config (dict) – configuration file that includes the directory where the nourishment database is stored.

  • dimension (pd.dataframe) – dataframe containing the values of a characteristic parameter through time and more multiple transect locations.

Returns

  • pd.dataframe – nourished_dataframe: dataframe containing the values of a characteristic parameter of only transect that have been nourished.

  • pd.dataframe – not_nourished_dataframe: dataframe containing the values of a characteristic parameter of only transect that have not been nourished.

JAT.Filtering_functions.yrs_filter(dimension, begin_year, end_year)

Filter out user-defined years.

Filter values of a characteristic parameter that are associated with a range of years that is specified by the user.

Parameters
  • dimension (pd.dataframe) – dataframe containing the values of a characteristic parameter through time and more multiple transect locations.

  • begin_yr (int) – Start year of the range that should be filtered

  • end_yr (int) – End year of the range that should be filtered

Returns

dimension_filt: dataframe containing the values of a characteristic parameter where filtered years have been removed.

Return type

pd.dataframe