swot_simulator.product_specification.Swath

class swot_simulator.product_specification.Swath(track: swot_simulator.orbit_propagator.Pass, central_pixel: bool = False, product_type: Optional[str] = None)[source]

Bases: swot_simulator.product_specification.Nadir

Handle the KaRIn measurements dataset.

Parameters

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

  • central_pixel (bool) – Inserts or not in the swath, a central pixel divided in two by the reference ground track.

__init__(track: swot_simulator.orbit_propagator.Pass, central_pixel: bool = False, product_type: Optional[str] = None) → None[source]

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

Methods

Swath.simulated_true_ssh(array)

Sets the variable describing the KaRIn SSH free of measurement errors.

Swath.ssh(array)

Sets the variable describing the KaRIn SSH.

Swath.swh(array)

Sets the variable describing the KaRIn SWH.

Swath.to_netcdf(cycle_number, pass_number, …)

Writes the dataset in a netCDF file.

Swath.to_xarray(cycle_number, pass_number, …)

Converts this instance into a xarray dataset.

Swath.update_noise_errors(noise_errors)

Sets the values of the simulated errors.