Land Sea Masking Scripts - Revision history

Robertson at 13:10, 4 May 2012

2012-05-04T13:10:13Z

Robertson at 13:38, 2 May 2012

2012-05-02T13:38:05Z

Arango at 03:35, 25 April 2012

2012-04-25T03:35:23Z

← Older revision		Revision as of 03:35, 25 April 2012
Line 41:		Line 41:
	::<span class="green">right click</span>,   zoom out		::<span class="green">right click</span>,   zoom out
	::<span class="green">middle click</span>,   change editing mode<section end=editscope.m />		::<span class="green">middle click</span>,   change editing mode<section end=editscope.m />


			<section begin=ijcoast.m />;<span id="ijcoast"></span><span class="blue">ijcoast.m</span>
			:Converts coastline data to ROMS (I,J) fractional coordinates to facilitate Land/Sea masking editing with [[:Land_Sea_Masking_Scripts#editmask\|editmask]]. <br />
			::<span class="green">C</span> = <span class="red">ijcoast</span>  (<span class="green">ncfile</span>, <span class="green">coast_file)
			:'''On Input:'''
			::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
			::<span class="green">coast_file</span>:   Coastline file name (string)
			:'''On Output:'''
			::<span class="green">C</span>:   Coastline data (struct array)
			:::<span class="green">C.grid </span>,   ROMS Grid NetCDF file name
			:::<span class="green">C.coast </span>,   Coastline file name
			:::<span class="green">C.indices</span>,   Coastline indices file name
			:::<span class="green">C.lon </span>,   Coastline longitudes
			:::<span class="green">C.lat </span>,   Coastline latitudes
			:::<span class="green">C.Icst </span>,   Coastline I-grid coordinates, (0:L)
			:::<span class="green">C.Jcst </span>,   Coastline J-grid coordinates, (0:M)<section end=ijcoast.m />


			<section begin=landsea.m />;<span id="landsea"></span><span class="blue">landsea.m</span>
			:Computes automatically the Land/Sea mask for an application grid and writes it into input NetCDF file. The Land/Sea mask is computed from closed coastlines polygons extracted from the GSHHS data set if the (<span class="green">clon</span>, <span class="green">clat</span>) coastline data is not provided. <br />
			::<span class="green">F</span> = <span class="red">lansea</span>  (<span class="green">ncfile</span>, <span class="green">clon</span>, <span class="green">clat</span>)
			:'''On Input:'''
			::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
			::<span class="green">clon </span>:   Coastline longitude (1D array; degrees_west)
			::<span class="green">clat </span>:   Coastline latitude (1D array; degrees_north)
			:'''On Output:'''
			::<span class="green">F</span>:   Land/Sea mask data (struct array)
			:::<span class="green">F.mask_rho</span>,   Mask on '''ρ'''-points (2D array)
			:::<span class="green">F.mask_psi</span>,   Mask on &'''psi;'''-points (2D array)
			:::<span class="green">F.mask_u </span>,   Mask on '''u'''-points (2D array)
			:::<span class="green">F.mask_v </span>,   Mask on '''v'''-points (2D array) <section end=landsea.m />


			<section begin=read_mask.m />;<span id="read_mask"></span><span class="blue">read_mask.m</span>
			:Reads in ROMS grid bathymetry and Land/Sea mask at ρ-point from NetCDF file. <br />
			::[<span class="green">spherical</span>, <span class="green">x</span>, <span class="green">y</span>, <span class="green">bath</span>, <span class="green">rmask</span>] = <span class="red">read_mask</span>  (<span class="green">ncfile</span>)
			:'''On Input:'''
			::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
			:'''On Output:'''
			::<span class="green">spherical</span>,   Spherical switch (logical)
			::<span class="green">x </span>,   X-location of ρ-points
			::<span class="green">y </span>,   Y-location of ρ-points
			::<span class="green">bath </span>,   Bathymetry at ρ-points
			::<span class="green">rmask </span>,   Land/Sea mask at ρ-points<section end=read_mask.m />


			<section begin=read_scope.m />;<span id="read_scope"></span><span class="blue">read_scope.m</span>
			:Reads in ROMS grid bathymetry and adjoint sensitivity scope mask at ρ-point from NetCDF file. <br />
			::[<span class="green">spherical</span>, <span class="green">x</span>, <span class="green">y</span>, <span class="green">bath</span>, <span class="green">rmask</span>] = <span class="red">read_mask</span>  (<span class="green">ncfile</span>)
			:'''On Input:'''
			::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
			:'''On Output:'''
			::<span class="green">spherical</span>,   Spherical switch (logical)
			::<span class="green">x </span>,   X-location of ρ-points
			::<span class="green">y </span>,   Y-location of ρ-points
			::<span class="green">bath </span>,   Bathymetry at ρ-points
			::<span class="green">rmask </span>,   Land/Sea mask at ρ-points<section end=read_scope.m />


			<section begin=uvp_masks.m />;<span id="uvp_masks"></span><span class="blue">uvp_masks.m</span>
			:Computes the Land/Sea masks at '''u'''-, '''v'''-, and '''ψ'''-points from the mask on '''ρ'''-points. <br />
			::[<span class="green">umask</span>, <span class="green">vmask</span>, <span class="green">vmask</span>] = <span class="red">uvp_masks</span>  (<span class="green">rmask</span>)
			:'''On Input:'''
			::<span class="green">rmask</span>:   Land/Sea mask on '''ρ'''-points (2D array)
			:'''On Output:'''
			::<span class="green">umask</span>,   Land/Sea mask on '''u'''-points (2D array)
			::<span class="green">vmask</span>,   Land/Sea mask on '''v'''-points (2D array)
			::<span class="green">rmask</span>,   Land/Sea mask on '''ψ'''-points (2D array) <section end=uvp_masks.m />


			<section begin=uv_scope.m />;<span id="uv_scope"></span><span class="blue">uv_scope.m</span>
			:Computes the adjoint sensitivity scope masks at '''u'''- and '''v'''-points from the scope mask on '''ρ'''-points. <br />
			::[<span class="green">Uscope</span>, <span class="green">Vscope</span>] = <span class="red">uvp_masks</span>  (<span class="green">Rscope</span>)
			:'''On Input:'''
			::<span class="green">Rscope</span>:   Scope mask on '''ρ'''-points (2D array)
			:'''On Output:'''
			::<span class="green">Uscope</span>,   Scope mask on '''u'''-points (2D array)
			::<span class="green">Vscope</span>,   Scope mask on '''v'''-points (2D array)<section end=uv_scope.m />


			<section begin=write_mask.m />;<span id="write_mask"></span><span class="blue">write_mask.m</span>
			:Writes out Land/Sea mask data into ROMS Grid NetCDF file. <br />
			::span class="green">status</span> = <span class="red">write_mask</span>  (<span class="green">ncfile</span>, span class="green">rmask</span>, <span class="green">umask</span>, <span class="green">vmask</span>, <span class="green">pmask</span>)
			:'''On Input:'''
			::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
			::<span class="green">rmask </span>,   Land/Sea mask on '''ρ'''-points (2D array)
			::<span class="green">umask </span>,   Land/Sea mask on '''u'''-points (2D array)
			::<span class="green">vmask </span>,   Land/Sea mask on '''v'''-points (2D array)
			::<span class="green">pmask </span>,   Land/Sea mask on '''ψ'''-points (2D array)
			:'''On Output:'''
			::<span class="green">status</span>,   Error flag<section end=write_mask.m />


			<section begin=write_scope.m />;<span id="write_scope"></span><span class="blue">write_scope.m</span>
			:Writes out adjoint sensitivity scope mask data into ROMS Grid NetCDF file. <br />
			::span class="green">status</span> = <span class="red">write_mask</span>  (<span class="green">ncfile</span>, span class="green">Rscope</span>, <span class="green">Uscope</span>, <span class="green">Vscope</span>)
			:'''On Input:'''
			::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
			::<span class="green">Rscope</span>,   Adjoint sensitivity scope mask on '''ρ'''-points (2D array)
			::<span class="green">Uscope</span>,   Adjoint sensitivity scope mask on '''u'''-points (2D array)
			::<span class="green">Vscope</span>,   Adjoint sensitivity scope mask on '''v'''-points (2D array)
			:'''On Output:'''
			::<span class="green">status</span>,   Error flag<section end=write_scope.m />

Arango: Created page with "
Matlab: Land/Sea Masking Scripts
NOTOC This page describes several Matlab scripts in the '''matlab/landmask''' repository sub-directory, which are us…"

2012-04-25T01:48:04Z

Created page with "<div class="title">Matlab: Land/Sea Masking Scripts</div>__NOTOC__ This page describes several Matlab scripts in the '''matlab/landmask''' repository sub-directory, which are us…"

New page

<div class="title">Matlab: Land/Sea Masking Scripts</div>__NOTOC__

This page describes several Matlab scripts in the '''matlab/landmask''' repository sub-directory, which are used to process ROMS Land/Sea mask.


<div style="float: left;margin: 0 20px 0 0;">{{Matlab Scripts TOC}}</div>__NOTOC__

<div style="clear: both"></div>

<section begin=add_coastline.m />;<span id="add_coastline"></span><span class="blue">add_coastline.m</span>
:Adds coastline data to ROMS Grid NetCDF file. This is the coastline data is used to facilitate Land/Sea masking editing. <br />
::<span class="red">add_coastline</span>  (<span class="green">ncfile</span>, <span class="green">Clon</span>, <span class="green">Clat</span>)
:'''On Input:'''
::<span class="green">ncfile</span>:   ROMS Grid NetCDF file name (string)
::<span class="green">Clon </span>:   Coastline longitude (1D array, degree_east)
::<span class="green">Clat </span>:   Coastline latitude (1D array, degree_north)<section end=add_coastline.m />

<section begin=editmask.m />;<span id="editmask"></span><span class="blue">editmask.m</span>
:GUI for manual editing of ROMS Land/Sea mask on RHO-points. To accelerate the processing, the Land/Sea mask is edited in (I,J) grid coordinates. If the (I,J) coordinates are not provided, it compute and write them into file. If called without, one or both arguments, it will prompt for the needed file name(s). If the coastline data is in grid_file, it will read it and convert to (I,J) fractional coordinates. <br />
::<span class="red">editmask</span>  (<span class="green">grid_file</span>, <span class="green">coast_file</span>)
:'''On Input:'''
::<span class="green">grid_file </span>:   ROMS Grid NetCDF file name containing the grid and mask arrays (string)
::<span class="green">coast_file</span>:   Matlab file name containing the coastline (lon, lat) or (I,J) fractional coordinates (string; optional)
:'''Mouse shortcuts:'''
::<span class="green">double click</span>,   zoom in
::<span class="green">right click</span>,   zoom out
::<span class="green">middle click</span>,   change editing mode<section end=editmask.m />

<section begin=editscope.m />;<span id="editscope"></span><span class="blue">editscope.m</span>
:GUI for manual editing of ROMS adjoint sensitivity scope mask on RHO-points. To accelerate the processing, the Land/Sea mask is edited in (I,J) grid coordinates. If the (I,J) coordinates are not provided, it compute and write them into file. If called without, one or both arguments, it will prompt for the needed file name(s). If the coastline data is in grid_file, it will read it and convert to (I,J) fractional coordinates. <br />
::<span class="red">editscope</span>  (<span class="green">grid_file</span>, <span class="green">coast_file</span>)
:'''On Input:'''
::<span class="green">grid_file </span>:   ROMS Grid NetCDF file name containing the grid and mask arrays (string)
::<span class="green">coast_file</span>:   Matlab file name containing the coastline (lon, lat) or (I,J) fractional coordinates (string; optional)
:'''Mouse shortcuts:'''
::<span class="green">double click</span>,   zoom in
::<span class="green">right click</span>,   zoom out
::<span class="green">middle click</span>,   change editing mode<section end=editscope.m />

← Older revision		Revision as of 13:38, 2 May 2012
Line 11:		Line 11:

	<section begin=add_coastline.m />;<span id="add_coastline"></span><span class="blue">add_coastline.m</span>		<section begin=add_coastline.m />;<span id="add_coastline"></span><span class="blue">add_coastline.m</span>
	:Adds coastline data to ROMS Grid NetCDF file. This is the coastline data is used to facilitate Land/Sea masking editing. <br />		:Adds coastline data to ROMS Grid NetCDF file. This is the coastline data used to facilitate Land/Sea masking editing. <br />
	::<span class="red">add_coastline</span>  (<span class="green">ncfile</span>, <span class="green">Clon</span>, <span class="green">Clat</span>)		::<span class="red">add_coastline</span>  (<span class="green">ncfile</span>, <span class="green">Clon</span>, <span class="green">Clat</span>)
	:'''On Input:'''		:'''On Input:'''
Line 20:		Line 20:

	<section begin=editmask.m />;<span id="editmask"></span><span class="blue">editmask.m</span>		<section begin=editmask.m />;<span id="editmask"></span><span class="blue">editmask.m</span>
	:GUI for manual editing of ROMS Land/Sea mask on RHO-points. To accelerate the processing, the Land/Sea mask is edited in (I,J) grid coordinates. If the (I,J) coordinates are not provided, it compute and write them into file. If called without, one or both arguments, it will prompt for the needed file name(s). If the coastline data is in grid_file, it will read it and convert to (I,J) fractional coordinates. <br />		:GUI for manual editing of ROMS Land/Sea mask on RHO-points. To accelerate the processing, the Land/Sea mask is edited in (I,J) grid coordinates. If the (I,J) coordinates are not provided, it will compute and write them into a file. If called without one or both arguments, it will prompt for the needed file name(s). If the coastline data is in grid_file, it will read it and convert to (I,J) fractional coordinates. <br />
	::<span class="red">editmask</span>  (<span class="green">grid_file</span>, <span class="green">coast_file</span>)		::<span class="red">editmask</span>  (<span class="green">grid_file</span>, <span class="green">coast_file</span>)
	:'''On Input:'''		:'''On Input:'''
Line 32:		Line 32:

	<section begin=editscope.m />;<span id="editscope"></span><span class="blue">editscope.m</span>		<section begin=editscope.m />;<span id="editscope"></span><span class="blue">editscope.m</span>
	:GUI for manual editing of ROMS adjoint sensitivity scope mask on RHO-points. To accelerate the processing, the Land/Sea mask is edited in (I,J) grid coordinates. If the (I,J) coordinates are not provided, it compute and write them into file. If called without, one or both arguments, it will prompt for the needed file name(s). If the coastline data is in grid_file, it will read it and convert to (I,J) fractional coordinates. <br />		:GUI for manual editing of ROMS adjoint sensitivity scope mask on RHO-points. To accelerate the processing, the Land/Sea mask is edited in (I,J) grid coordinates. If the (I,J) coordinates are not provided, it will compute and write them into a file. If called without one or both arguments, it will prompt for the needed file name(s). If the coastline data is in grid_file, it will read it and convert to (I,J) fractional coordinates. <br />
	::<span class="red">editscope</span>  (<span class="green">grid_file</span>, <span class="green">coast_file</span>)		::<span class="red">editscope</span>  (<span class="green">grid_file</span>, <span class="green">coast_file</span>)
	:'''On Input:'''		:'''On Input:'''
Line 61:		Line 61:

	<section begin=landsea.m />;<span id="landsea"></span><span class="blue">landsea.m</span>		<section begin=landsea.m />;<span id="landsea"></span><span class="blue">landsea.m</span>
	:Computes ~~automatically~~ the Land/Sea mask for an application grid and writes it into input NetCDF file. The Land/Sea mask is computed from closed coastlines polygons extracted from the GSHHS data set if the (<span class="green">clon</span>, <span class="green">clat</span>) coastline data is not provided. <br />		:Computes the Land/Sea mask for an application grid atomatically and writes it into an input NetCDF file. The Land/Sea mask is computed from closed coastlines polygons extracted from the GSHHS data set if the (<span class="green">clon</span>, <span class="green">clat</span>) coastline data is not provided. <br />
	::<span class="green">F</span> = <span class="red">lansea</span>  (<span class="green">ncfile</span>, <span class="green">clon</span>, <span class="green">clat</span>)		::<span class="green">F</span> = <span class="red">lansea</span>  (<span class="green">ncfile</span>, <span class="green">clon</span>, <span class="green">clat</span>)
	:'''On Input:'''		:'''On Input:'''
Line 70:		Line 70:
	::<span class="green">F</span>:   Land/Sea mask data (struct array)		::<span class="green">F</span>:   Land/Sea mask data (struct array)
	:::<span class="green">F.mask_rho</span>,   Mask on '''ρ'''-points (2D array)		:::<span class="green">F.mask_rho</span>,   Mask on '''ρ'''-points (2D array)
	:::<span class="green">F.mask_psi</span>,   Mask on &'''psi;'''-points (2D array)		:::<span class="green">F.mask_psi</span>,   Mask on '''ψ'''-points (2D array)
	:::<span class="green">F.mask_u </span>,   Mask on '''u'''-points (2D array)		:::<span class="green">F.mask_u </span>,   Mask on '''u'''-points (2D array)
	:::<span class="green">F.mask_v </span>,   Mask on '''v'''-points (2D array) <section end=landsea.m />		:::<span class="green">F.mask_v </span>,   Mask on '''v'''-points (2D array) <section end=landsea.m />
Line 89:		Line 89:

	<section begin=read_scope.m />;<span id="read_scope"></span><span class="blue">read_scope.m</span>		<section begin=read_scope.m />;<span id="read_scope"></span><span class="blue">read_scope.m</span>
	:Reads in ROMS grid bathymetry and adjoint sensitivity scope mask at ρ-~~point~~ from NetCDF file. <br />		:Reads in ROMS grid bathymetry and adjoint sensitivity scope mask at ρ-points from NetCDF file. <br />
	::[<span class="green">spherical</span>, <span class="green">x</span>, <span class="green">y</span>, <span class="green">bath</span>, <span class="green">rmask</span>] = <span class="red">read_mask</span>  (<span class="green">ncfile</span>)		::[<span class="green">spherical</span>, <span class="green">x</span>, <span class="green">y</span>, <span class="green">bath</span>, <span class="green">rmask</span>] = <span class="red">read_mask</span>  (<span class="green">ncfile</span>)
	:'''On Input:'''		:'''On Input:'''
Line 124:		Line 124:
	<section begin=write_mask.m />;<span id="write_mask"></span><span class="blue">write_mask.m</span>		<section begin=write_mask.m />;<span id="write_mask"></span><span class="blue">write_mask.m</span>
	:Writes out Land/Sea mask data into ROMS Grid NetCDF file. <br />		:Writes out Land/Sea mask data into ROMS Grid NetCDF file. <br />
	::span class="green">status</span> = <span class="red">write_mask</span>  (<span class="green">ncfile</span>, span class="green">rmask</span>, <span class="green">umask</span>, <span class="green">vmask</span>, <span class="green">pmask</span>)		::<span class="green">status</span> = <span class="red">write_mask</span>  (<span class="green">ncfile</span>, <span class="green">rmask</span>, <span class="green">umask</span>, <span class="green">vmask</span>, <span class="green">pmask</span>)
	:'''On Input:'''		:'''On Input:'''
	::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)		::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)
Line 137:		Line 137:
	<section begin=write_scope.m />;<span id="write_scope"></span><span class="blue">write_scope.m</span>		<section begin=write_scope.m />;<span id="write_scope"></span><span class="blue">write_scope.m</span>
	:Writes out adjoint sensitivity scope mask data into ROMS Grid NetCDF file. <br />		:Writes out adjoint sensitivity scope mask data into ROMS Grid NetCDF file. <br />
	::span class="green">status</span> = <span class="red">write_mask</span>  (<span class="green">ncfile</span>, span class="green">Rscope</span>, <span class="green">Uscope</span>, <span class="green">Vscope</span>)		::<span class="green">status</span> = <span class="red">write_mask</span>  (<span class="green">ncfile</span>, <span class="green">Rscope</span>, <span class="green">Uscope</span>, <span class="green">Vscope</span>)
	:'''On Input:'''		:'''On Input:'''
	::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)		::<span class="green">ncname</span>:   ROMS grid NetCDF file name (string)

Land Sea Masking Scripts - Revision history

Robertson at 13:10, 4 May 2012

Robertson at 13:38, 2 May 2012

Arango at 03:35, 25 April 2012

Arango: Created page with "Matlab: Land/Sea Masking Scripts__NOTOC__ This page describes several Matlab scripts in the '''matlab/landmask''' repository sub-directory, which are us…"

Arango: Created page with "
Matlab: Land/Sea Masking Scripts
NOTOC This page describes several Matlab scripts in the '''matlab/landmask''' repository sub-directory, which are us…"