Category:CliffMetrics - Revision history

CTL1 at 11:06, 17 April 2024

2024-04-17T11:06:03Z

← Older revision		Revision as of 12:06, 17 April 2024
Line 78:		Line 78:
	==== Inputs ====		==== Inputs ====

	~~The SAGA~~ Linux version 1.0 requires ~~18 inputs, as shown below~~. The format of the input file ~~is an ASCII file,~~ with comments preceded by a semi-colon as the following file:		After CliffMetrics instalation, the Linux version 1.0 requires a input ASCII file (*.dat). The format of the input file has 18 inputs with comments preceded by a semi-colon as the following file:

			;
	''; SIMPLE TEST DATA''		''; SIMPLE TEST DATA''
	''Run information -----------------------------------------------------------------------------------------------------''		;
			'';Run information -----------------------------------------------------------------------------------------------------''
	''1 Main output/log file names [omit path and extension]: simple''		''1 Main output/log file names [omit path and extension]: simple''
	''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc''		''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc''
Line 88:		Line 90:
	''5 Coastline smoothing window size [must be odd]: 55 ''		''5 Coastline smoothing window size [must be odd]: 55 ''
	''6 Polynomial order for Savitsky-Golay coastline smoothing [2 or 4]: 4''		''6 Polynomial order for Savitsky-Golay coastline smoothing [2 or 4]: 4''
	''If user wants to use a given shoreline vector instead of extracting it from the DTM ''
			'';If user wants to use a given shoreline vector instead of extracting it from the DTM ''
	''7 Shoreline shape file (OPTIONAL GIS FILES) [path and name]: in/simple_fast/chain_coastline.shp ''		''7 Shoreline shape file (OPTIONAL GIS FILES) [path and name]: in/simple_fast/chain_coastline.shp ''
	''8 Sea handiness (which side of shoreline the sea is? )[right = 0 or left = 1]: 0 ''		''8 Sea handiness (which side of shoreline the sea is? )[right = 0 or left = 1]: 0 ''
	''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 ''		''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 ''
	''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 ''		''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 ''
	''Advance Run information ------------------------------------------------------------------------------------------------''
			'';Advance Run information ------------------------------------------------------------------------------------------------''
	''11 GIS raster output format [blank=same as DEM input]: gtiff ;gdal-config --formats for others''		''11 GIS raster output format [blank=same as DEM input]: gtiff ;gdal-config --formats for others''
	''12 If needed, also output GIS raster world file? [y/n]: y''		''12 If needed, also output GIS raster world file? [y/n]: y''
Line 102:		Line 106:
	''17 Length of coastline normals (m) : 50''		''17 Length of coastline normals (m) : 50''
	''18 Vertical tolerance to consider to elevation different (m) : 0.5''		''18 Vertical tolerance to consider to elevation different (m) : 0.5''
	''END OF FILE -----------------------------------------------------------------------------------------------------------''<br>		'';END OF FILE -----------------------------------------------------------------------------------------------------------''<br>

	To run the software, follow instruction at GitHub website.		To run the software, follow instruction at GitHub website.

CTL1 at 14:11, 16 April 2024

2024-04-16T14:11:43Z

← Older revision		Revision as of 15:11, 16 April 2024
Line 112:		Line 112:
	Download input data from '''https://bgs.sharefile.eu/share/getinfo/s9001cf5659546359''' '''CHANGE url'''		Download input data from '''https://bgs.sharefile.eu/share/getinfo/s9001cf5659546359''' '''CHANGE url'''

	The study area is ''St Bees head (3.6252W; 54.5128N'') in Cumbria County in northwest England (UK) and defined in EPSG 27700 (OSGB36 / British National Grid). The '''Inputs.zip''' file contains:<br>		The study area is ''[https://maps.google.com/?q=<54.5128>,<-3.6252> St Bees head (3.6252W; 54.5128N)]'' in Cumbria County in northwest England (UK) and defined in EPSG 27700 (OSGB36 / British National Grid). The '''Inputs.zip''' file contains:<br>

	- a 5 m resolution DEM model in geotiff format ('''DEM.tif''') from NEXTMap dataset, (https://catalogue.ceda.ac.uk/uuid/8f6e1598372c058f07b0aeac2442366d) derived by airborne radar technology, <br>		- a 5 m resolution DEM model in geotiff format ('''DEM.tif''') from NEXTMap dataset, (https://catalogue.ceda.ac.uk/uuid/8f6e1598372c058f07b0aeac2442366d) derived by airborne radar technology, <br>

CTL1 at 14:08, 16 April 2024

2024-04-16T14:08:26Z

CTL1 at 14:07, 16 April 2024

2024-04-16T14:07:33Z

← Older revision		Revision as of 15:07, 16 April 2024
Line 82:		Line 82:
	''; SIMPLE TEST DATA<br>''		''; SIMPLE TEST DATA<br>''
	''Run information -----------------------------------------------------------------------------------------------------<br>''		''Run information -----------------------------------------------------------------------------------------------------<br>''
	''1 Main output/log file names [omit path and extension]: simple~~<br>~~''		''1 Main output/log file names [omit path and extension]: simple''
			''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc''
	''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc~~<br>~~''		''3 Still water level (m) used to find the shoreline : 75 ''
			''4 Coastline smoothing [0=none, 1=running mean, 2=Savitsky-Golay]: 1''
	''3 Still water level (m) used to find the shoreline : 75 ~~<br>~~''		''5 Coastline smoothing window size [must be odd]: 55 ''
			''6 Polynomial order for Savitsky-Golay coastline smoothing [2 or 4]: 4''
	''4 Coastline smoothing [0=none, 1=running mean, 2=Savitsky-Golay]: 1~~<br>~~''		''If user wants to use a given shoreline vector instead of extracting it from the DTM ''
			''7 Shoreline shape file (OPTIONAL GIS FILES) [path and name]: in/simple_fast/chain_coastline.shp ''
	''5 Coastline smoothing window size [must be odd]: 55 ~~<br>~~''		''8 Sea handiness (which side of shoreline the sea is? )[right = 0 or left = 1]: 0 ''
			''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 ''
	''6 Polynomial order for Savitsky-Golay coastline smoothing [2 or 4]: 4~~<br>~~''		''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 ''
			''Advance Run information -----------------------------------------------------------------------------------------------------''
	''If user wants to use a given shoreline vector instead of extracting it from the DTM ~~<br>~~''		''11 GIS raster output format [blank=same as DEM input]: gtiff ;gdal-config --formats for others''
			''12 If needed, also output GIS raster world file? [y/n]: y''
	''7 Shoreline shape file (OPTIONAL GIS FILES) [path and name]: in/simple_fast/chain_coastline.shp ~~<br>~~''		''13 If needed, scale GIS raster output values? [y/n]: y''
			''14 GIS vector output format : ESRI Shapefile ; ogrinfo --formats for others''
	''8 Sea handiness (which side of shoreline the sea is? )[right = 0 or left = 1]: 0 ~~<br>~~''		''15 Random edge for coastline search? [y/n]: n''
			''16 Random number seed(s) : 280761''
	''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 ~~<br>~~''		''17 Length of coastline normals (m) : 50''
			''18 Vertical tolerance to consider to elevation different (m) : 0.5''
	''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 ~~<br>~~''

	''Advance Run information -----------------------------------------------------------------------------------------------------~~<br>~~''

	''11 GIS raster output format [blank=same as DEM input]: gtiff ;
	gdal-config --formats for others''~~<br>~~

	''12 If needed, also output GIS raster world file? [y/n]: y''~~<br>~~

	''13 If needed, scale GIS raster output values? [y/n]: y''~~<br>~~

	''14 GIS vector output format : ESRI Shapefile ; ogrinfo --formats for others''~~<br>~~

	''15 Random edge for coastline search? [y/n]: n''~~<br>~~

	''16 Random number seed(s) : 280761''~~<br>~~

	''17 Length of coastline normals (m) : 50'' ~~<br>~~

	''18 Vertical tolerance to consider to elevation different (m) : 0.5''~~<br>~~

	''END OF FILE ----------------------------------------------------------------------------------------------------------''<br>		''END OF FILE ----------------------------------------------------------------------------------------------------------''<br>


	To run the software, follow instruction at GitHub website.		To run the software, follow instruction at GitHub website.

CTL1 at 14:03, 16 April 2024

2024-04-16T14:03:31Z

Show changes

Agarcia at 13:55, 16 April 2024

2024-04-16T13:55:13Z

← Older revision		Revision as of 14:55, 16 April 2024
Line 218:		Line 218:

	== Version history ==		== Version history ==
	- 2018 October: CliffMetrics v1.0 published in Geosci. Model Dev. https://~~github~~.~~com~~/~~coastalme~~/~~CliffMetrics. Stand~~-~~alone CliffMetrics is still maintained in GitHub by Dr. Andres Payo.~~		- 2018 October: CliffMetrics v1.0 published in Geosci. Model Dev. [https://DOI https://doi.org/10.5194/gmd-11-4317-2018]

	- 2019 August: Included in the official SAGA Repository (v7.3.0) https://sourceforge.net/p/saga-gis/code/ci/master/tree/		- 2019 August: Included in the official SAGA Repository (v7.3.0) https://sourceforge.net/p/saga-gis/code/ci/master/tree/
Line 229:		Line 229:

	== References ==		== References ==
	- ClifMetricsv1.0 Geosci. Model Dev., 11, 4317–4337, 2018 (https://~~gmd.copernicus~~.org/~~articles~~/11/4317/2018/)		- ClifMetricsv1.0 Geosci. Model Dev., 11, 4317–4337, 2018 (https://doi.org/10.5194/gmd-11-4317-2018)

	- SAGA software https://sourceforge.net/projects/saga-gis/		- SAGA software https://sourceforge.net/projects/saga-gis/

	- SAGA CliffMetrics library: Library CliffMetrics / SAGA-GIS Tool Library Documentation (v9.0.0) (sourceforge.io)		- SAGA CliffMetrics library: Library CliffMetrics / SAGA-GIS Tool Library Documentation (v9.0.0) (sourceforge.io)

CTL1 at 13:44, 16 April 2024

2024-04-16T13:44:26Z

Show changes

CTL1 at 13:32, 16 April 2024

2024-04-16T13:32:30Z

← Older revision		Revision as of 14:32, 16 April 2024
Line 154:		Line 154:

	- Open CliffMetrics tool (“Geoprocessing”>> “Terrain Analysis” >> “Coastal Morphology” >> “CliffMetrics”). From this step, we explain the two different input options in Cliffmetrics: an automatic delineation of the coastline or using a layer of coastline points.		- Open CliffMetrics tool (“Geoprocessing”>> “Terrain Analysis” >> “Coastal Morphology” >> “CliffMetrics”). From this step, we explain the two different input options in Cliffmetrics: an automatic delineation of the coastline or using a layer of coastline points.

			=== WITH AUTOMATIC COASTLINE DELINATION ===
			From the previous step:
			- Define only the DEM as input data in “Data Objects”:
			- Elevation: “Data Objects”>> “Grid System” click (<not set>) to configurate the spatial environment and select the number of pixels and the coordinate origin of “2001x 8001y; 289997.5x 500002.4998y” corresponding to the DEM file environment. Now, you can select the file “1.DEM” in “Elevation” section.
			- Define the CliffMetrics options in “Options”:
			- Still Water Level: elevation of coastline automatically delineated by 1 m to avoid some protective infrastructure.
			- Coastline Smoothing Algorithm: Select “running mean” as value. The shoreline point layer and its DEM have detailed geometry and resolution, so a smoothing algorithm is recommended to avoid a large number of crossings between profiles. You can try with “Savitsky-Golay” if the results are not satisfactory for the final purpose.
			- Coastline Smoothing Window Size: The coastline is abrupt, so the default “30” points might be a good starting value for the smoothing algorithm.
			- Scale Raster Output Values: Default “Active”.
			- Random Edge for Coastline Search: Default “Active”.
			- Length of Coastline Normal: Set 100 m.
			- Vertical tolerance: Set 0.5 m. Although the DEM has a spatial resolution of 5 m, the vertical accuracy of this altimetry radar is 0.5 m, so this is the minimum value to detect an altimetric change accurately.
			- Main Output File directory: Define the output folder.
			- Review these values as in Fig. 7 and press “Okay”.


			''Fig. 7. CliffMetrics input for the option “with automatic coastline delineation”''


			- In “Messages” window you can follow the started and succeeded execution with the time processing in brackets:
			- [CliffMetrics] Execution started...
			- [CliffMetrics] Execution succeeded (12s)
			CliffMetrics preload geographical information into “Data” tab in “Manager” window. These are the “Sediment Top Elevation” (Grid), “coast” and “normals” as line layers, “cliff_top”, “clip_toe” and “coast_points” as points and “Data” as a table, see Fig. 8. Fig.9 shows a SAGA visualisation of these results. The rest of the information is saved in the output folder (the CSV and LOG files).


			''Fig. 8. Preloaded CliffMetrics output for the option “With automatic coastline delineation”''

			''Fig.9. Map view of some preloaded outputs from CliffMetrics into SAGA.''

			- Save the project (“File”>>”Project”>>”Save Project” ) and the unsaved layers with “Select all” and press “Okay”.


			=== WITH A COASTLINE POINT LAYER ===
			This option requires as additional input data the coastline_points.shp file. This layer and the line coastline layers have already loaded previously before the processing “WITH AUTOMATIC COASTLINE DELINATION”. You can display them on a new SAGA map.
			To run this example, follow the “WITH AUTOMATIC COASTLINE DELINATION” input data process and add the definition of the coastline_points.shp in the input data under “Data Objects”:
			- Coastline: click (<not set>) and select coastline_points. It is also necessary to define three related aspects:
			 Sea handiness: indicates that sea is to the right/left of the user defined coastline as a person traverse it from the beginning (East boundary, up) to end (East boundary, bottom). In this example, sea is on the right.
			 Start edge coastline: at which DEM edge (North, East, South, West) the user defined coastline begins. In this example, it starts at the East edge.
			 End edge coastline: at which DEM edge (North, East, South, West) the user defined coastline end. In this example, it ends at the same edge (East) where it started.
			- Once you have defined the rest of the parameters as in Fig. 10, press “Okay”.


			''Fig.10. CliffMetrics input for the option “With a Coastline Point layer”''


			- In “Messages” window you can follow the started and succeeded execution with the time processing in brackets:
			- [CliffMetrics] Execution started...
			- [CliffMetrics] Execution succeeded (12s)
			- Save the project (“File”>>”Project”>>”Save Project”) and the unsaved layers with “Select all” and press “Okay”.
			The CliffMetrics preload geographical information is the same as “WITH AUTOMATIC COASTLINE DELINATION” option “Data” tab in “Manager” window. Fig.11 shows a SAGA visualisation of these results. Other information is saved in the output folder (the csv and log files).


			''Fig.11. Map view of some CliffMetrics outputs preload in SAGA, including the resulting cliff toe and top positions.''

			== Version history ==
			- 2018 October: CliffMetrics v1.0 published in Geosci. Model Dev. https://github.com/coastalme/CliffMetrics. Stand-alone CliffMetrics is still maintained in GitHub by Dr. Andres Payo.
			- 2019 August: Included in the official SAGA Repository (v7.3.0) https://sourceforge.net/p/saga-gis/code/ci/master/tree/
			- 2020 September: Added option of using a user defined input coastline https://ci.appveyor.com/project/johanvdw/saga-gis-git-mirror/build/artifacts
			- 2020 November: SAGA SAGA v7.8.0 https://sourceforge.net/p/saga-gis/code/ci/master/tree/ . An always up-to-date SAGA development version from the automated AppVeyor build system by SAGA developers. Go to SourceForge to download the latest version of SAGA.
			- 2024 January: Included in previous versions from SAGA v7.8.0 and lastest SAGA v9.3.1 Library CliffMetrics / SAGA-GIS Tool Library Documentation (v9.0.0) (sourceforge.io)

			== References ==
			- ClifMetricsv1.0 Geosci. Model Dev., 11, 4317–4337, 2018 (https://gmd.copernicus.org/articles/11/4317/2018/)
			- SAGA software https://sourceforge.net/projects/saga-gis/
			- SAGA CliffMetrics library: Library CliffMetrics / SAGA-GIS Tool Library Documentation (v9.0.0) (sourceforge.io)

CTL1 at 13:27, 16 April 2024

2024-04-16T13:27:39Z

← Older revision		Revision as of 14:27, 16 April 2024
Line 131:		Line 131:
	The Linux version of CliffMetrics produces the same results as the SAGA GIS version. Outputs are saved in the user defined folder, as explained in the README file in the dedicated GitHub repository.		The Linux version of CliffMetrics produces the same results as the SAGA GIS version. Outputs are saved in the user defined folder, as explained in the README file in the dedicated GitHub repository.
	== Example SAGA WINDOWS ==		== Example SAGA WINDOWS ==
	Download input data from h'''~~ttps~~://bgs.sharefile.eu/share/getinfo/s9001cf5659546359'''		Download input data from '''https://bgs.sharefile.eu/share/getinfo/s9001cf5659546359''' '''change url'''

	The study area is St Bees head (3.6252W; 54.5128N) in Cumbria County in northwest England (UK) and defined in EPSG 27700 (OSGB36 / British National Grid). The '''Inputs.zip''' file contains:		The study area is ''St Bees head (3.6252W; 54.5128N'') in Cumbria County in northwest England (UK) and defined in EPSG 27700 (OSGB36 / British National Grid). The '''Inputs.zip''' file contains:<br>
	- a 5 m resolution DEM model in geotiff format ('''DEM.tif''') from NEXTMap dataset (https://catalogue.ceda.ac.uk/uuid/8f6e1598372c058f07b0aeac2442366d) derived by airborne radar technology,
	- a coastline as a line shapefile ('''coastline.shp'''),		- a 5 m resolution DEM model in geotiff format ('''DEM.tif''') from NEXTMap dataset, (https://catalogue.ceda.ac.uk/uuid/8f6e1598372c058f07b0aeac2442366d) derived by airborne radar technology, <br>
			- a coastline as a line shapefile ('''coastline.shp'''),<br>
	- a user defined coastline points in shapefile format ('''coastline_points.shp''') obtained from the previous file ('''coastline.shp''').		- a user defined coastline points in shapefile format ('''coastline_points.shp''') obtained from the previous file ('''coastline.shp''').

	Follow these steps:		Follow these '''steps''':

	- Open SAGA software		- Open SAGA software<br>
	- Load the data in SAGA:		- Load the data in SAGA:
	* DEM: “File”>>” Grid”>>”Load”, browse the folder and select the “DEM.tif” file and click on “Open”		* DEM: “File”>>” Grid”>>”Load”, browse the folder and select the “DEM.tif” file and click on “Open”
	* Load the Shapefiles: “File”>>”Shapes”>>”Load”, navigate to the folder and select the coastline_points.shp (not necessary in the case of automatic delineation) and then, the coastline.shp (remember, this last line shape is for a better coastal representation of the coast and is included as auxiliary information). The Shapefile format is composed by several files, but the main file to load is *.shp		* Load the Shapefiles: “File”>>”Shapes”>>”Load”, navigate to the folder and select the coastline_points.shp (not necessary in the case of automatic delineation) and then, the coastline.shp (remember, this last line shape is for a better coastal representation of the coast and is included as auxiliary information). The Shapefile format is composed by several files, but the main file to load is *.shp
	NOTE: Another load option could be to use the “Data Sources” panel. Find the folder in this panel and right click button on each file and select “Open”.		'''''NOTE''': Another load option could be to use the “Data Sources” panel. Find the folder in this panel and right click button on each file and select “Open”.'' <br>
	- View the data: you can now select the “Data” window tab in the “Manager” box and view the data by double-clicking on the names. When choosing the second layer, be sure to select the same map window as the first layer. SAGA will probably show you a warning about a different coordinate system and the option to turn on projection On-the-fly, in this case click “Yes” ('''Fig. 6'''). You can change the ~~symbology~~ and ~~colour~~ by opening “Object Properties” window.
			- View the data: you can now select the “Data” window tab in the “Manager” box and view the data by double-clicking on the names. When choosing the second layer, be sure to select the same map window as the first layer. SAGA will probably show you a warning about a different coordinate system and the option to turn on projection On-the-fly, in this case click “Yes” ('''Fig. 6'''). You can change the symbol and color by opening “Object Properties” window.<br>
	- Save the project in this step with an arbitrary name: “File”>>”Project”>>”Save Project”.		- Save the project in this step with an arbitrary name: “File”>>”Project”>>”Save Project”.


	''Fig. 6. Visualize the example data. This DEM shows the lowest elevation in blue and the highest elevations in red. Sea cells have been assigned as 0 m (dark blue)''		''Fig. 6. Visualize the example data. This DEM shows the lowest elevation in blue and the highest elevations in red. Sea cells have been assigned as 0 m (dark blue)''

	- Open CliffMetrics tool (“Geoprocessing”>> “Terrain Analysis” >> “Coastal Morphology” >> “CliffMetrics”). From this step, we explain the two different input options in Cliffmetrics: an automatic delineation of the coastline or using a layer of coastline points.		- Open CliffMetrics tool (“Geoprocessing”>> “Terrain Analysis” >> “Coastal Morphology” >> “CliffMetrics”). From this step, we explain the two different input options in Cliffmetrics: an automatic delineation of the coastline or using a layer of coastline points.

CTL1 at 13:18, 16 April 2024

2024-04-16T13:18:48Z

← Older revision		Revision as of 14:18, 16 April 2024
Line 15:		Line 15:
	* in Geoprocessing menu, go to “Terrain Analysis” >> “Coastal Morphology” >> “CliffMetrics”,		* in Geoprocessing menu, go to “Terrain Analysis” >> “Coastal Morphology” >> “CliffMetrics”,
	* in the Tools pane as it is shown in '''Fig. 2''', “Tools”>> “Terrain Analysis” >> “CliffMetrics”.		* in the Tools pane as it is shown in '''Fig. 2''', “Tools”>> “Terrain Analysis” >> “CliffMetrics”.


	''Fig.2. Integration of CliffMetrics into SAGA software''		''Fig.2. Integration of CliffMetrics into SAGA software''
Line 23:		Line 24:
	''Fig. 3. The CliffMetrics input data window''		''Fig. 3. The CliffMetrics input data window''

	The “Data Objects” section is composed by the '''“Elevation”''' (bellow “Grids”>> “Grids System”) in “Grid System” subsection and the '''“User Defined Coastline Points”''' in “Shapes” subsection. Optional parameters need to be defined in “Options” section. In more detail:		The “Data Objects” section is composed by the '''“Elevation”''' (bellow “Grids”>> “Grids System”) in “Grid System” subsection and the '''“User Defined Coastline Points”''' in “Shapes” subsection. Optional parameters need to be defined in “Options” section. In more detail:<br>

	- Grid System:		- Grid System:
	*'''Elevation''': Define the Grid System used in SAGA, and it is the primary elevation source. All types of DEM files supported in SAGA can be used. IMPORTANT! For the automatic coastline delineation option (no '''User Defined Coastline Points''' as input), the user-defined DEM must NOT have non-data values around the edges. CliffMetrics starts searching for the coastline by traversing the edges of the DEM.		*'''Elevation''': Define the Grid System used in SAGA, and it is the primary elevation source. All types of DEM files supported in SAGA can be used. IMPORTANT! For the automatic coastline delineation option (no '''User Defined Coastline Points''' as input), the user-defined DEM must NOT have non-data values around the edges. CliffMetrics starts searching for the coastline by traversing the edges of the DEM.
	- Shapes:		- Shapes:
	*'''User Defined coastline points''': This layer sets the starting points of transect positions on the coastline if you include it. All vector file types supported in SAGA can be used. CliffMetrics only read the coordinates of the point and the ordinal (sequential order of saving to the file). Ordinals identify the Start (n=1) and End (n=last) points of User Defined Coastline Points, so the points must have been stored along the coastline. If the starting point is outside of the DEM domain, the first user-defined shoreline point within the DEM boundaries is automatically selected as the starting point. The User Defined Coastline Points are used as an initial reference to find the centre of the raster DEM cell closest to them. This ~~centre~~ will be the starting point for the transects. In addition, it is necessary to define three aspects in advance:		*'''User Defined coastline points''': This layer sets the starting points of transect positions on the coastline if you include it. All vector file types supported in SAGA can be used. CliffMetrics only read the coordinates of the point and the ordinal (sequential order of saving to the file). Ordinals identify the Start (n=1) and End (n=last) points of User Defined Coastline Points, so the points must have been stored along the coastline. If the starting point is outside of the DEM domain, the first user-defined shoreline point within the DEM boundaries is automatically selected as the starting point. The User Defined Coastline Points are used as an initial reference to find the centre of the raster DEM cell closest to them. This center will be the starting point for the transects. In addition, it is necessary to define three aspects in advance:
	#'''Sea handiness''': This parameter establishes which DEM side of the coastline is the sea if a person is imagined walking from the starting point to the end of the user defined coastline, see Fig.4.		#'''Sea handiness''': This parameter establishes which DEM side of the coastline is the sea if a person is imagined walking from the starting point to the end of the user defined coastline, see '''Fig.4'''.
	#'''Start edge coastline''': Defines which DEM edge (North, East, South, West) the user defined coastline starts at, see Fig. 4.		#'''Start edge coastline''': Defines which DEM edge (North, East, South, West) the user defined coastline starts at, see '''Fig. 4'''.
	#'''End edge coastline''': This parameter identifies which DEM edge (North, East, South, West) the user defined coastline ends at, see Fig. 4.		#'''End edge coastline''': This parameter identifies which DEM edge (North, East, South, West) the user defined coastline ends at, see '''Fig. 4'''.
	- Options:		- Options:
	*'''Still Water Level''': the user-defined vertical elevation for the automatically delineated coastline. Default is 1 m above the datum used for the DEM. This will likely be different for your DEM.		*'''Still Water Level''': the user-defined vertical elevation for the automatically delineated coastline. Default is 1 m above the datum used for the DEM. This will likely be different for your DEM.
	*'''Coastline Smoothing Algorithm''': Smoothing algorithm to apply. There are three options: “None”, “running mean” or “Savitsky-Golay”, see Fig. 4. The default is “running mean” (https://en.wikipedia.org/wiki/Moving_average).		*'''Coastline Smoothing Algorithm''': Smoothing algorithm to apply. There are three options: “None”, “running mean” or “Savitsky-Golay”, see '''Fig. 4'''. The default is “running mean” (https://en.wikipedia.org/wiki/Moving_average).
	*'''Coastline Smoothing Window Size''': The number of selected points to smooth the coastline. Smoothing the coastline produces normals that are more parallel to each other, see '''Fig. 4.''' The default value is “30” points.		*'''Coastline Smoothing Window Size''': The number of selected points to smooth the coastline. Smoothing the coastline produces normals that are more parallel to each other, see '''Fig. 4.''' The default value is “30” points.

Line 72:		Line 74:
	=== GitHub repository ===		=== GitHub repository ===
	The Linux version is available via the dedicated GitHub repository here:		The Linux version is available via the dedicated GitHub repository here:
	https://github.com/apayo/CliffMetrics/		https://github.com/apayo/CliffMetrics/<br>
	'''INPUTS'''~~'''~~
			'''INPUTS'''

	The SAGA Linux version 1.0 requires 18 inputs, as shown below. The format of the input file is an ASCII file, with comments preceded by a semi-colon as the following file:		The SAGA Linux version 1.0 requires 18 inputs, as shown below. The format of the input file is an ASCII file, with comments preceded by a semi-colon as the following file:

	''; SIMPLE TEST DATA		''; SIMPLE TEST DATA<br>''
	;		''Run information -----------------------------------------------------------------------------------------------------<br>''
	; Run information -----------------------------------------------------------------------------------------------------		''1 Main output/log file names [omit path and extension]: simple<br>''
	1 Main output/log file names [omit path and extension]: simple
	2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc		''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc<br>''
	3 Still water level (m) used to find the shoreline : 75
	4 Coastline smoothing [0=none, 1=running mean, 2=Savitsky-Golay]: 1		''3 Still water level (m) used to find the shoreline : 75 <br>''
	5 Coastline smoothing window size [must be odd]: 55
	6 Polynomial order for Savitsky-Golay coastline smoothing [2 or 4]: 4		''4 Coastline smoothing [0=none, 1=running mean, 2=Savitsky-Golay]: 1<br>''
	; If user wants to use a given shoreline vector instead of extracting it from the DTM
	7 Shoreline shape file (OPTIONAL GIS FILES) [path and name]: in/simple_fast/chain_coastline.shp		''5 Coastline smoothing window size [must be odd]: 55 <br>''
	8 Sea handiness (which side of shoreline the sea is? )[right = 0 or left = 1]: 0
	9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1		''6 Polynomial order for Savitsky-Golay coastline smoothing [2 or 4]: 4<br>''
	10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3
	; Advance Run information -----------------------------------------------------------------------------------------------------		''If user wants to use a given shoreline vector instead of extracting it from the DTM <br>''
	11 GIS raster output format [blank=same as DEM input]: gtiff ; gdal-config --formats for others
	12 If needed, also output GIS raster world file? [y/n]: y		''7 Shoreline shape file (OPTIONAL GIS FILES) [path and name]: in/simple_fast/chain_coastline.shp <br>''
	13 If needed, scale GIS raster output values? [y/n]: y
	14 GIS vector output format : ESRI Shapefile ; ogrinfo --formats for others		''8 Sea handiness (which side of shoreline the sea is? )[right = 0 or left = 1]: 0 <br>''
	15 Random edge for coastline search? [y/n]: n
	16 Random number seed(s) : 280761		''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 <br>''
	17 Length of coastline normals (m) : 50
	18 Vertical tolerance to consider to elevation different (m) : 0.5		''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 <br>''
	; END OF FILE ----------------------------------------------------------------------------------------------------------''
			''Advance Run information -----------------------------------------------------------------------------------------------------<br>''

			11 GIS raster output format [blank=same as DEM input]: gtiff ;
			gdal-config --formats for others<br>

			12 If needed, also output GIS raster world file? [y/n]: y<br>

			13 If needed, scale GIS raster output values? [y/n]: y<br>

			14 GIS vector output format : ESRI Shapefile ; ogrinfo --formats for others<br>

			15 Random edge for coastline search? [y/n]: n<br>

			16 Random number seed(s) : 280761<br>

			17 Length of coastline normals (m) : 50 <br>

			18 Vertical tolerance to consider to elevation different (m) : 0.5<br>

			END OF FILE ----------------------------------------------------------------------------------------------------------''<br>


	To run the software, follow instruction at GitHub website.		To run the software, follow instruction at GitHub website.

	=== OUTPUTS ===		=== OUTPUTS ===
	The Linux version of CliffMetrics produces the same results as the SAGA GIS version. Outputs are saved in the user defined folder, as explained in the README file in the dedicated GitHub repository.		The Linux version of CliffMetrics produces the same results as the SAGA GIS version. Outputs are saved in the user defined folder, as explained in the README file in the dedicated GitHub repository.

← Older revision		Revision as of 15:08, 16 April 2024
Line 80:		Line 80:
	The SAGA Linux version 1.0 requires 18 inputs, as shown below. The format of the input file is an ASCII file, with comments preceded by a semi-colon as the following file:		The SAGA Linux version 1.0 requires 18 inputs, as shown below. The format of the input file is an ASCII file, with comments preceded by a semi-colon as the following file:

	''; SIMPLE TEST DATA~~<br>~~''		''; SIMPLE TEST DATA''
	''Run information -----------------------------------------------------------------------------------------------------~~<br>~~''		''Run information -----------------------------------------------------------------------------------------------------''
	''1 Main output/log file names [omit path and extension]: simple''		''1 Main output/log file names [omit path and extension]: simple''
	''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc''		''2 DTM file (DTM MUST BE PRESENT) [path and name]: in/simple_fast/two_bays.asc''
Line 93:		Line 93:
	''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 ''		''9 On which Edge is the start of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 1 ''
	''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 ''		''10 On which Edge is the end of user shoreline? [N = 1, E = 2, S = 3, W = 4]: 3 ''
	''Advance Run information ~~-----~~------------------------------------------------------------------------------------------------''		''Advance Run information ------------------------------------------------------------------------------------------------''
	''11 GIS raster output format [blank=same as DEM input]: gtiff ;gdal-config --formats for others''		''11 GIS raster output format [blank=same as DEM input]: gtiff ;gdal-config --formats for others''
	''12 If needed, also output GIS raster world file? [y/n]: y''		''12 If needed, also output GIS raster world file? [y/n]: y''
Line 102:		Line 102:
	''17 Length of coastline normals (m) : 50''		''17 Length of coastline normals (m) : 50''
	''18 Vertical tolerance to consider to elevation different (m) : 0.5''		''18 Vertical tolerance to consider to elevation different (m) : 0.5''
	''END OF FILE ----------------------------------------------------------------------------------------------------------''<br>		''END OF FILE -----------------------------------------------------------------------------------------------------------''<br>

	To run the software, follow instruction at GitHub website.		To run the software, follow instruction at GitHub website.