mo_read_spatial_data Module Reference

Reads spatial input data. More...

Data Types
interface	read_spatial_data_ascii
	Reads spatial data files of ASCII format. More...

Functions/Subroutines
subroutine	read_spatial_data_ascii_dp (filename, fileunit, header_ncols, header_nrows, header_xllcorner, header_yllcorner, header_cellsize, data, mask)
	TODO: add description.
subroutine	read_spatial_data_ascii_i4 (filename, fileunit, header_ncols, header_nrows, header_xllcorner, header_yllcorner, header_cellsize, data, mask)
	TODO: add description.
subroutine, public	read_header_ascii (filename, fileunit, header_ncols, header_nrows, header_xllcorner, header_yllcorner, header_cellsize, header_nodata)
	Reads header lines of ASCII files.

Detailed Description

Reads spatial input data.

This module is to read spatial input data, e.g. dem, aspect, flow direction. The module provides a subroutine for ASCII files. (Subroutine for NetCDF files will come with release 5.1). The data are read from the specified directory.

Authors

Juliane Mai

Date

Dec 2012

Copyright

Copyright 2005-2024, the mHM Developers, Luis Samaniego, Sabine Attinger: All rights reserved. mHM is released under the LGPLv3+ license

The UFZ(CHS) mesoscale hydrologic model mHM is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the free Software Foundation either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You received a copy of the GNU Lesser General Public License along with the UFZ CHS mesoscale hydrologic model mHM. It can be found in the files COPYING and COPYING.LESSER provided with this software. The complete GNU license text can also be found at http://www.gnu.org/licenses/.

Function/Subroutine Documentation

read_header_ascii()

subroutine, public mo_read_spatial_data::read_header_ascii	(	character(len = *), intent(in)	filename,
		integer(i4), intent(in)	fileunit,
		integer(i4), intent(out)	header_ncols,
		integer(i4), intent(out)	header_nrows,
		real(dp), intent(out)	header_xllcorner,
		real(dp), intent(out)	header_yllcorner,
		real(dp), intent(out)	header_cellsize,
		real(dp), intent(out)	header_nodata
	)

Reads header lines of ASCII files.

Reads header lines of ASCII files, e.g. dem, aspect, flow direction.

Parameters

[in]	character(len = *) :: filename	Name of file and its location
[in]	integer(i4) :: fileunit	File unit for open file
[out]	integer(i4) :: header_nCols	Reference number of columns
[out]	integer(i4) :: header_nRows	Reference number of rows
[out]	real(dp) :: header_xllcorner	Reference lower left corner (x)
[out]	real(dp) :: header_yllcorner	Reference lower left corner (y)
[out]	real(dp) :: header_cellsize	Reference cell size [m]
[out]	real(dp) :: header_nodata	Reference nodata value

Authors

Juliane Mai

Date

Jan 2013

Definition at line 375 of file mo_read_spatial_data.f90.

References mo_common_constants::nodata_dp.

Referenced by mo_meteo_handler::init_level2(), mo_common_read_data::read_dem(), mo_read_spatial_data::read_spatial_data_ascii::read_spatial_data_ascii_dp(), and mo_read_spatial_data::read_spatial_data_ascii::read_spatial_data_ascii_i4().

Here is the caller graph for this function:

read_spatial_data_ascii_dp()

subroutine mo_read_spatial_data::read_spatial_data_ascii_dp ( character(len = *), intent(in)  filename, integer(i4), intent(in)  fileunit, integer(i4), intent(in)  header_ncols, integer(i4), intent(in)  header_nrows, real(dp), intent(in)  header_xllcorner, real(dp), intent(in)  header_yllcorner, real(dp), intent(in)  header_cellsize, real(dp), dimension(:, :), intent(out), allocatable  data, logical, dimension(:, :), intent(out), allocatable  mask  )

private

TODO: add description.

TODO: add description

Parameters

[in]	character(len = *) :: filename	filename with location
[in]	integer(i4) :: fileunit	unit for opening the file
[in]	integer(i4) :: header_nCols	number of columns of data fields:
[in]	integer(i4) :: header_nRows	number of rows of data fields:
[in]	real(dp) :: header_xllcorner	header read in lower left corner
[in]	real(dp) :: header_yllcorner	header read in lower left corner
[in]	real(dp) :: header_cellsize	header read in cellsize
[out]	real(dp), dimension(:, :) :: data	data
[out]	logical, dimension(:, :) :: mask	mask

Authors

Robert Schweppe

Date

Jun 2018

Definition at line 94 of file mo_read_spatial_data.f90.

read_spatial_data_ascii_i4()

subroutine mo_read_spatial_data::read_spatial_data_ascii_i4 ( character(len = *), intent(in)  filename, integer(i4), intent(in)  fileunit, integer(i4), intent(in)  header_ncols, integer(i4), intent(in)  header_nrows, real(dp), intent(in)  header_xllcorner, real(dp), intent(in)  header_yllcorner, real(dp), intent(in)  header_cellsize, integer(i4), dimension(:, :), intent(out), allocatable  data, logical, dimension(:, :), intent(out), allocatable  mask  )

private

TODO: add description.

TODO: add description

Parameters

[in]	character(len = *) :: filename	filename with location
[in]	integer(i4) :: fileunit	unit for opening the file
[in]	integer(i4) :: header_nCols	number of columns of data fields:
[in]	integer(i4) :: header_nRows	number of rows of data fields:
[in]	real(dp) :: header_xllcorner	header read in lower left corner
[in]	real(dp) :: header_yllcorner	header read in lower left corner
[in]	real(dp) :: header_cellsize	header read in cellsize
[out]	integer(i4), dimension(:, :) :: data	data
[out]	logical, dimension(:, :) :: mask	mask

Authors

Robert Schweppe

Date

Jun 2018

Definition at line 234 of file mo_read_spatial_data.f90.