..  _platform_class:

Platform
^^^^^^^^

The Platform class is  a top level class describing the platform used in the simulation or retrieval. The class
is builds on base class `PlatformPointing` and has an :ref:`observationpolicy_class` object.
The class provides a selection of methods to set the position, orientation and time of the platform.
Quick links to some of the more useful methods are below,

* Platform and Instrument Orientation methods
    * :meth:`~.PlatformPointing.orient_instrument_on_platform`
    * :meth:`~.PlatformPointing.orient_platform_in_space`
* Instrument Boresight Pointing methods
    * :meth:`~.PlatformPointing.set_boresight_to_look_at_geodetic_location`
    * :meth:`~.PlatformPointing.set_boresight_to_look_at_tangent_altitude_and_azimuth`
    * :meth:`~.PlatformPointing.set_boresight_to_look_at_geocentric_location`
* Platform Location methods
    * :meth:`~.PlatformPointing.set_platform_location`
    * :meth:`~.PlatformPointing.location`
    * :meth:`~.PlatformPointing.local_west`
    * :meth:`~.PlatformPointing.local_south`
    * :meth:`~.PlatformPointing.local_up`
* Pointing Rotation Matrices
    * :meth:`~.PlatformPointing.convert_icf_to_geo`
    * :meth:`~.PlatformPointing.convert_icf_to_gcf`
    * :meth:`~.PlatformPointing.convert_gcf_to_geo`
    * :meth:`~.PlatformPointing.get_icf_to_geo_matrix`


.. autoclass:: skimpy.Platform
    :members:
    :special-members: __init__

..  _platformpointing_class:

Platform_Pointing
-----------------

.. autoclass:: skimpy.platform.platform_pointing.PlatformPointing
    :members: