swot_simulator.product_specification.ProductSpecification

class swot_simulator.product_specification.ProductSpecification(product_type: Optional[str])[source]

Bases: object

Parse and load into memory the product specification@@

__init__(product_type: Optional[str])[source]

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

Methods

ProductSpecification.fill_value(properties)

Returns the fill value encoded with the data type specified

ProductSpecification.fill_variables(…)

Returns the properties of variables present in the official format of the SWOT product, but not calculated by this software.

ProductSpecification.lat(lat)

Returns the properties of the variable describing the latitudes of the swath

ProductSpecification.lat_nadir(lat_nadir)

Returns the properties of the variable describing the latitudes of the reference ground track

ProductSpecification.lon(lon)

Returns the properties of the variable describing the longitudes of the swath

ProductSpecification.lon_nadir(lon_nadir)

Returns the properties of the variable describing the longitudes of the reference ground track

ProductSpecification.simulated_error_altimeter(array)

Returns the properties of the variable describing the altimeter error

ProductSpecification.simulated_error_baseline_dilation(array)

Returns the properties of the variable describing the error due to baseline mast dilation

ProductSpecification.simulated_error_karin(array)

Returns the properties of the variable describing the KaRIn error

ProductSpecification.simulated_error_phase(array)

Returns the properties of the variable describing the error due to phase

ProductSpecification.simulated_error_roll(array)

Returns the properties of the variable describing the error due to roll

ProductSpecification.simulated_error_timing(array)

Returns the properties of the variable describing the timing error

ProductSpecification.simulated_error_troposphere(array)

Returns the properties of the variable describing the error due to wet troposphere path delay

ProductSpecification.simulated_error_troposphere_nadir(array)

Returns the properties of the variable describing the error due to wet troposphere path delay to nadir.

ProductSpecification.simulated_roll_phase_estimate(array)

Returns the properties of the variable describing the roll phase correction estimated

ProductSpecification.simulated_true_ssh_karin(array)

Returns the properties of the variable describing the SSH KaRIn free of measurement errors.

ProductSpecification.simulated_true_ssh_nadir(array)

Returns the properties of the variable describing the SSH to nadir free of measurement errors.

ProductSpecification.ssh_karin(ssh)

Returns the properties of the variable describing the SSH measured by KaRIn

ProductSpecification.ssh_nadir(array)

Returns the properties of the variable describing the SSH to nadir.

ProductSpecification.swh_karin(swh)

Returns the properties of the variable describing the SSH measured by KaRIn

ProductSpecification.swh_nadir(array)

Returns the properties of the variable describing the SSH to nadir free of measurement errors.

ProductSpecification.time(time)

Gets the time axis

ProductSpecification.x_ac(x_ac)

Returns the properties of the variable describing the cross track distance

ProductSpecification.__contains__(item)

ProductSpecification._data_array(name, data)

Returns a tuple containing the netCDF encoding of the variable and the data array.

Attributes

ProductSpecification.SPECIFICATION