Output Data#

Output Files#

Depending on your selection of single or multi-file dataset (refer to Multi-File Datasets), the output file can be one of the following:

1. Output for Single Dataset#

If your input consists of a single dataset (either as a single input file or multiple files representing a single dataset), the output result will be a single .nc file.

2. Output for Multi-File Dataset#

If your input files represent multiple separate datasets (refer to Multiple Separate Dataset, Each within a File section), a distinct output file with a .nc format is generated for each input file (or URL). These output files are named similarly to their corresponding input files. All of these files are then bundled into a .zip file.

Output Variables#

The results of restoreio are stored in a NetCDF file with a .nc format. This file comprises a range of variables, as outlined below, depending on the chosen configuration.

  1. Mask

  2. Reconstructed East and North Velocities

  3. East and North Velocity Errors

  4. East and North Velocity Ensemble

1. Mask#

The mask variable is a three-dimensional array with dimensions for time, longitude, and latitude. This variable is stored under the name mask in the output file.

Interpreting Variable over Segmented Domains#

The mask variable includes information about the result of domain segmentation (refer to Domain Segmentation section). This array contains integer values -1, 0, 1, and 2 that are interpreted as follows:

  • The value -1 indicates the location is identified to be on the land domain \(\Omega_l\). In these locations, the output velocity variable is masked.

  • The value 0 indicates the location is identified to be on the known domain \(\Omega_k\). These locations have velocity data in the input file. The same velocity values are preserved in the output file.

  • The value 1 indicates the location is identified to be on the missing domain \(\Omega_m\). These locations do not have a velocity data in the input file, but they do have a reconstructed velocity data on the output file.

  • The value 2 indicates the location is identified to be on the ocean domain \(\Omega_0\). In these locations, the output velocity variable is masked.

2. Reconstructed East and North Velocities#

The reconstructed east and north velocity variables are stored in the output file under the names east_vel and north_vel, respectively. These variables are three-dimensional arrays with dimensions for time, longitude, and latitude.

Interpreting Variable over Segmented Domains#

The velocity variables on each of the segmented domains are defined as follows:

  • On locations where the Mask value is -1 or 2, the output velocity variables are masked.

  • On locations where the Mask value is 0, the output velocity variables have the same values as the corresponding variables in the input file.

  • On locations where the Mask value is 1, the output velocity variables are reconstructed. If the uncertainty_quant option is enabled, these output velocity variables are obtained by the mean of the velocity ensemble, where the missing domain of each ensemble is reconstructed.

3. East and North Velocity Errors#

If the uncertainty_quant option is enabled, the east and north velocity error variables will be included in the output file under the names east_err and north_err, respectively. These variables are three-dimensional arrays with dimensions for time, longitude, and latitude.

Interpreting Variable over Segmented Domains#

The velocity error variables on each of the segmented domains are defined as follows:

  • On locations where the Mask value is -1 or 2, the output velocity error variables are masked.

  • On locations where the Mask value is 0, the output velocity error variables are obtained from either the corresponding velocity error or GDOP variables in the input file scaled by the value of scale_error argument.

  • On locations where the Mask value is 1, the output velocity error variables are obtained from the standard deviation of the ensemble, where the missing domain of each ensemble is reconstructed.

4. East and North Velocity Ensemble#

When you activate the uncertainty_quant option, a collection of velocity field ensemble is created. Yet, by default, the output file only contains the mean and standard deviation of these ensemble members. To incorporate all ensemble members into the output file, you should additionally enable the write_samples option. This action saves the east and north velocity ensemble variables in the output file as east_vel_ensemble and north_vel_ensemble, respectively. These variables are four-dimensional arrays with dimensions for ensemble, time, longitude, and latitude.

Ensemble Dimension#

The ensemble dimension of the array has the size \(s+1\) where \(s\) is the number of samples specified by num_samples (also refer to Number of (Monte-Carlo) Samples section). The first ensemble with the index \(0\) (assuming zero-based numbering) corresponds to the original input dataset. The other ensemble members with the indices \(1, \dots, s\) correspond to the generated ensemble.

Interpreting Variable over Segmented Domains#

The velocity ensemble variables on each of the segmented domains are defined similar to those presented for Reconstructed East and North Velocities. In particular, the missing domain of each ensemble is reconstructed independently.

Mean and Standard Deviation of Ensemble#

Note that the mean and standard deviation of the velocity ensemble arrays over the ensemble dimension yield the Reconstructed East and North Velocities and East and North Velocity Errors variables, respectively.