.. _Station api:

=========
Station
=========

The Station holds all the data related to a single station. This includes:

* observational data, stored as ``SensorData``,
* metadata, stored as a ``Site``,
* and timeseries of a model source, stored as ``ModelTimeSeries``.

.. currentmodule:: metobs_toolkit.station

Constructor
-----------

.. autosummary::
   :toctree: api/

   Station

Data attributes
----------------
A summary of all the attributes that hold or return data.

.. autosummary::
   :toctree: api/

   Station.name
   Station.site
   Station.sensordata
   Station.df
   Station.metadf
   Station.outliersdf
   Station.gapsdf
   Station.modeldatadf
   Station.present_observations
   Station.start_datetime
   Station.end_datetime
   Station.modeldata


General methods and attributes
------------------------------

.. autosummary::
   :toctree: api/

   Station.get_sensor
   Station.add_to_sensordata
   Station.get_modeltimeseries
   Station.add_to_modeldata
   Station.get_info
   Station.resample
   Station.to_xr


GEE related methods
------------------------------
.. autosummary::
   :toctree: api/

   Station.modeldatadf
   Station.get_static_gee_point_data
   Station.get_static_gee_buffer_fraction_data
   Station.get_LCZ
   Station.get_altitude
   Station.get_landcover_fractions
   Station.get_gee_timeseries_data


Gaps related methods
------------------------------
.. autosummary::
   :toctree: api/

   Station.gapsdf
   Station.convert_outliers_to_gaps
   Station.interpolate_gaps
   Station.fill_gaps_with_raw_modeldata
   Station.fill_gaps_with_debiased_modeldata
   Station.fill_gaps_with_diurnal_debiased_modeldata
   Station.fill_gaps_with_weighted_diurnal_debiased_modeldata



Quality control related methods
--------------------------------
.. autosummary::
   :toctree: api/

   Station.outliersdf
   Station.gross_value_check
   Station.persistence_check
   Station.repetitions_check
   Station.step_check
   Station.window_variation_check
   Station.get_qc_stats
   Station.convert_outliers_to_gaps



Visualisations
------------------
.. autosummary::
   :toctree: api/

   Station.make_plot_of_modeldata
   Station.make_plot


Special methods
------------------

The `Station` class implements several Python special methods for convenience:

- ``__add__``: Combine two Station objects, merging sensordata, site and modeltimeseries. 

- ``__eq__``: Test equality between two Station objects.

- ``__str__`` and ``__repr__``: String representations for printing and debugging.

- ``copy``: Create a (deep) copy of the Station.

**Example usage:**

.. code-block:: python

   from metobs_toolkit.dataset import Dataset

   # Assume sta1 and sta2 are Station instances
   sta_extend = sta1 + sta2  # Merge Stations

   # Equality check
   if sta1 == sta2:
       print("Stations are equal")

   # Copying
   copy_of_1 = sta1.copy(deep=True)

   # String representation
   print(str(sta1))