swot_simulator.product_specification.Nadir

class swot_simulator.product_specification.Nadir(track: swot_simulator.orbit_propagator.Pass, standalone: bool = True, product_type: Optional[str] = None)[source]

Bases: object

Handle the nadir measurements dataset.

Parameters

  • track (orbit_propagator.Pass) – Properties of the half-orbit to write

  • standalone (bool) – True if this dataset is independent of the KaRIn dataset.

__init__(track: swot_simulator.orbit_propagator.Pass, standalone: bool = True, product_type: Optional[str] = None)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

Nadir.simulated_true_ssh(array)

Sets the variable describing the SSH to nadir free of measurement errors.

Nadir.ssh(array)

Sets the variable describing the SSH to nadir.

Nadir.swh(array)

Sets the variable describing the SSH to nadir.

Nadir.to_netcdf(cycle_number, pass_number, …)

Writes the dataset in a netCDF file.

Nadir.to_xarray(cycle_number, pass_number, …)

Converts this instance into a xarray dataset.

Nadir.update_noise_errors(noise_errors)

Sets the values of the simulated errors.

Nadir._data_array(attr, data[, fill_value])

Get the properties of a data array to be inserted in the dataset.