swot_simulator.launcher.file_path¶
- swot_simulator.launcher.file_path(first_date: numpy.datetime64, last_date: numpy.datetime64, cycle_number: int, pass_number: int, parameters: swot_simulator.settings.Parameters, nadir: bool = False) Optional[str] [source]¶
Get the absolute path of the file to be created.
- Parameters
first_date (numpy.datetime64) – Date of the first simulated measurement.
last_date (numpy.datetime64) – Date of the last simulated measurement.
cycle_number (int) – Cycle number of the file to be created.
pass_number (int) – Pass number of the file to be created.
parameters (settings.Parameters) – Simulation parameters.
nadir (bool, optional) – True if the product to be created contains the nadir measurements, false if it is a product containing the swath measurements.
- Returns
The path to the file to be created or None if the file already exists
- Return type
str, optional