Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • add_classes
  • gh-pages
  • develop
  • v2.0
5 results
Blame Permalink
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
ncfile_generation.py 4.73 KiB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159 






#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import os
import netCDF4 as nc
import settings


def generate_basic_ncfile(outfile, crs=None):
    
    """
        Initialise basic netCDF4 file
        
        Input:
            Outfile: path to store the netcdf file, string
            crs: coordinate reference system, string
    """

    # If outfile exists already, delete
    if os.path.exists(outfile):
        os.remove(outfile)

    ds = nc.Dataset(outfile, 'w', format='NETCDF4')

    return ds


def generate_ncfile(outfile, x, y, data, crs=None,
                    data_unit=None, missing_value=settings.no_value):

    """
        Save 2D dataset as netCDF4 file
        
        Input:
            Outfile: path to store the netcdf file, string
            x: longitude vector, list
            y: latitude vector, list
            data: 2D data array
            crs: coordinate reference system, string
            data_unit: data unit, string
            missing_value: no data value, integer or float
    """

    # If outfile exists already, delete
    if os.path.exists(outfile):
        os.remove(outfile)

    ds = nc.Dataset(outfile, 'w', format='NETCDF4')
    ds.createDimension('lon', len(x))
    ds.createDimension('lat', len(y))
    longitude = ds.createVariable('Longitude', 'f4', 'lon')
    latitude = ds.createVariable('Latitude', 'f4', 'lat')
    result = ds.createVariable('Result', 'f4', ('lat', 'lon'))

    longitude[:] = x
    latitude[:] = y
    result[:, :] = data

    # Provide global information in output-file
    if crs is not None:
        longitude.units = crs
        latitude.units = crs
    if data_unit is not None:
        result.units = data_unit
    ds.missing_value = missing_value
    ds.close()


def generate_3dncfile(outfile, x, y, data, dim, features, crs='wgs84',
                      data_unit=None, missing_value=settings.no_value):
    
    """
        Save 3D dataset as netCDF4 file, e.g. data cube
        
        Input:
            Outfile: path to store the netcdf file, string
            x: longitude vector, list
            y: latitude vector, list
            dim: number of 2D datasets, integer
            data: 2D data array
            features: contained features in prediction dataset, list of chars
            crs: coordinate reference system, string
            data_unit: data unit, string
            missing_value: no data value, integer or float
    """

    # If outfile exists already, delete
    if os.path.exists(outfile):
        os.remove(outfile)

    ds = nc.Dataset(outfile, 'w', format='NETCDF4')
    ds.createDimension('lon', len(x))
    ds.createDimension('lat', len(y))
    ds.createDimension('dim', dim)
    ds.createDimension('feat', len(features))
    longitude = ds.createVariable('Longitude', 'f4', 'lon')
    latitude = ds.createVariable('Latitude', 'f4', 'lat')
    result = ds.createVariable('Result', 'f4', ('lat', 'lon', 'dim'))
    Features = ds.createVariable('features', 'S1', 'feat')

    longitude[:] = x
    latitude[:] = y
    result[:, :, :] = data
    Features[:] = features

    # Provide global information in output-file
    if crs is not None:
        longitude.units = crs
        latitude.units = crs
    if data_unit is not None:
        result.units = data_unit
    ds.missing_value = missing_value
    ds.close()


def generate_2dncfile(outfile, x, y, data, features, crs='wgs84',
                      data_unit=None, missing_value=settings.no_value):
    
    """
        Save 2D dataset as netCDF4 file, e.g. Prediction dataset
        
        Input:
            Outfile: path to store the netcdf file, string
            x: longitude vector, list
            y: latitude vector, list
            data: 2D data array
            features: contained features in prediction dataset, list of chars
            crs: coordinate reference system, string
            data_unit: data unit, string
            missing_value: no data value, integer or float
    """

    # If outfile exists already, delete
    if os.path.exists(outfile):
        os.remove(outfile)

    ds = nc.Dataset(outfile, 'w', format='NETCDF4')
    ds.createDimension('lon', len(x))
    ds.createDimension('lat', len(y))
    ds.createDimension('feat', len(features))
    longitude = ds.createVariable('Longitude', 'f4', 'lon')
    latitude = ds.createVariable('Latitude', 'f4', 'lat')
    result = ds.createVariable('Result', 'f4', ('lat', 'lon'))
    Features = ds.createVariable('features', 'S1', 'feat')

    longitude[:] = x
    latitude[:] = y
    result[:, :] = data
    Features[:] = features

    # Provide global information in output-file
    if crs is not None:
        longitude.units = crs
        latitude.units = crs
    if data_unit is not None:
        result.units = data_unit
    ds.missing_value = missing_value
    ds.close()