.. _functionality:

=============
Functionality
=============

:mod:`irfpy.util` supports daily works of analyzing, handling,
interpreting data, which were obtained from observation
or calibration, as well as from simulation.

General
=======

.. autosummary::

        irfpy.util.irflab_wrapper

Math, physics in general
========================

.. autosummary::
	
	irfpy.util.ballistic
	irfpy.util.dipole
	irfpy.util.formula
        irfpy.util.physics
        irfpy.util.keplernumeric
        irfpy.util.lorentztrans
        irfpy.util.quaternion
        irfpy.util.solarspectra
        irfpy.util.sputtering
        irfpy.util.streamline
        irfpy.util.unitq

Constants
=========

.. autosummary::

        irfpy.util.constant
        irfpy.util.planets

Time, time series
=================

.. autosummary::
	
        irfpy.util.julday
        irfpy.util.tdict
        irfpy.util.timeinterval
        irfpy.util.time_panel
        irfpy.util.span
        irfpy.util.timeseries
        irfpy.util.timeseriesdb
        irfpy.util.utc

Energy spectrum and velocity distribution functions
===================================================

.. autosummary::
	
        irfpy.util.bipower
        irfpy.util.energyspectrum
        irfpy.util.fluxtools
        irfpy.util.kappa
        irfpy.util.maxwell
        irfpy.util.planck
        irfpy.util.sputtering
        irfpy.util.vdf

Random generator
================

.. autosummary::

        irfpy.util.maxwell
        irfpy.util.isotropy

Plasma instrument
=================

.. autosummary::
	
        irfpy.util.energyspectrum
        irfpy.util.fluxtools
        irfpy.util.sensortable

Geometry
========

.. autosummary::
	
        irfpy.util.fields
        irfpy.util.cone
        irfpy.util.graminan
        irfpy.util.gridsphere
        irfpy.util.icosahedron
        irfpy.util.intersection
        irfpy.util.polarframe
        irfpy.util.sphere
        irfpy.util.surfaceframe
        irfpy.util.tessellatedsphere
        irfpy.util.triangle
        irfpy.util.triangle2d
        irfpy.util.vectortools


Trajectory (spacecraft and particles)
=====================================

.. autosummary::
	
	irfpy.util.ballistic
        irfpy.util.rungekutta
        irfpy.util.keplernumeric
        irfpy.util.leapflog
        irfpy.util.streamline

Data file handling
==================

.. autosummary::
	
        irfpy.util.datafile
        irfpy.util.filepairv
        irfpy.util.irfpyrc
        irfpy.util.timeseriesdb

Statistics
==========

.. autosummary::
	
        irfpy.util.fivenumsum
        irfpy.util.likelihood

Numpy extension
===============

.. autosummary::

        irfpy.util.nptools

Interactive python
==================

.. autosummary::

        irfpy.util.unitq
        irfpy.util.physics
        irfpy.util.nptools

Graphical programming support
=============================

.. autosummary::
	
        irfpy.util.time_panel
        irfpy.util.tk

Help scripting development
==========================

.. autosummary::
	
	irfpy.util.check
        irfpy.util.exception
        irfpy.util.ndsparse
        irfpy.util.nptools
        irfpy.util.version
        irfpy.util.options
        irfpy.util.irfpyrc
        irfpy.util.profile
        irfpy.util.ringcache
        irfpy.util.with_context
        irfpy.util.tk