Functionality¶

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

General¶

irfpy.util.irflab_wrapper

Command executed in from irflab import *

Math, physics in general¶

`irfpy.util.ballistic`	Ballistic trajectory related module
`irfpy.util.dipole`	Dipole fields, such as electric or magnetic fields.
`irfpy.util.formula`	A collection of plasma physics related formulae.
`irfpy.util.physics`	Collection of physical formulae
`irfpy.util.keplernumeric`	Kepler's trajectory using numeric solvers
`irfpy.util.lorentztrans`	Functions for Lorenz transformation
`irfpy.util.quaternion`	An implementation of quaternion.
`irfpy.util.solarspectra`	Solar spectrum models at the Earth orbit
`irfpy.util.sputtering`	A formulation of sputtering
`irfpy.util.streamline`	Tracing a field to make a stream line
`irfpy.util.unitq`	Unit handling using external "quantities" module.

Constants¶

`irfpy.util.constant`	This module provides a collection of physical constants.
`irfpy.util.planets`	Constant or parameters of planetary/lunar bodies.

Time, time series¶

`irfpy.util.julday`	Implementation of Julian day.
`irfpy.util.tdict`	This module provides an implementation of time series of data
`irfpy.util.timeinterval`	Time inteval module.
`irfpy.util.time_panel`	Utility for time series panels, such as E-t diagram
`irfpy.util.span`	Module related to span (interval).
`irfpy.util.timeseries`	Time sereis related classes.
`irfpy.util.timeseriesdb`	This module provides an implementation of time series of database index.
`irfpy.util.utc`	Universal time related module.

Energy spectrum and velocity distribution functions¶

`irfpy.util.bipower`	A module for functions of two component power law.
`irfpy.util.energyspectrum`	Generic purpose energy spectrum implementation
`irfpy.util.fluxtools`	Tools for flux (differential, velocity distribution)
`irfpy.util.kappa`	Kappa distribution.
`irfpy.util.maxwell`	Module collecting maxwell distribution function related functions.
`irfpy.util.planck`	Collection of Planck's black body radiation formulae.
`irfpy.util.sputtering`	A formulation of sputtering
`irfpy.util.vdf`	Represents velocity distribution function.

Random generator¶

`irfpy.util.maxwell`	Module collecting maxwell distribution function related functions.
`irfpy.util.isotropy`	Functions for isotropic distribution

Plasma instrument¶

`irfpy.util.energyspectrum`	Generic purpose energy spectrum implementation
`irfpy.util.fluxtools`	Tools for flux (differential, velocity distribution)
`irfpy.util.sensortable`	A common template for plasma sensor table.

Geometry¶

`irfpy.util.fields`	Scalar field or 3-D vector field in 2-D or 3-D spaces
`irfpy.util.cone`	Cone is a cone, a geometry.
`irfpy.util.graminan`	Module for Gramian matrix
`irfpy.util.gridsphere`	A gridded sphere.
`irfpy.util.icosahedron`	Module for regular icosahedron.
`irfpy.util.intersection`	Calculate intersection between LoS and sphere.
`irfpy.util.polarframe`	Polar frame related module.
`irfpy.util.sphere`	Sphere, a geometry
`irfpy.util.surfaceframe`	An implementation of conversion to surface-interaction frame.
`irfpy.util.tessellatedsphere`	Tessellating a sphere surface by triangles.
`irfpy.util.triangle`	Module for triangle in 3-D space.
`irfpy.util.triangle2d`	Triangle in 2D.
`irfpy.util.vectortools`	Vector (numpy array) related functions

Trajectory (spacecraft and particles)¶

`irfpy.util.ballistic`	Ballistic trajectory related module
`irfpy.util.rungekutta`	Runge-Kutta implementations (for particle tracing)
`irfpy.util.keplernumeric`	Kepler's trajectory using numeric solvers
`irfpy.util.leapflog`	A module for particle tracing by leap flog.
`irfpy.util.streamline`	Tracing a field to make a stream line

Data file handling¶

`irfpy.util.datafile`	irfpy-standard data file.
`irfpy.util.filepairv`	Local cache system for huge data files
`irfpy.util.irfpyrc`	Configure file support for irfpy library.
`irfpy.util.timeseriesdb`	This module provides an implementation of time series of database index.

Statistics¶

`irfpy.util.fivenumsum`	Module for five value summary.
`irfpy.util.likelihood`	Functions for likelihood.

Numpy extension¶

irfpy.util.nptools

In house numpy helpers.

Interactive python¶

`irfpy.util.unitq`	Unit handling using external "quantities" module.
`irfpy.util.physics`	Collection of physical formulae
`irfpy.util.nptools`	In house numpy helpers.

Graphical programming support¶

`irfpy.util.time_panel`	Utility for time series panels, such as E-t diagram
`irfpy.util.tk`	Tkinter helper module.

Help scripting development¶

`irfpy.util.check`	Misc functions related to discovering typical programming errors.
`irfpy.util.exception`	Handling irfpy exception and error.
`irfpy.util.ndsparse`	Multidimensional sparse array.
`irfpy.util.nptools`	In house numpy helpers.
`irfpy.util.version`
`irfpy.util.options`	Misc function related to option handling.
`irfpy.util.irfpyrc`	Configure file support for irfpy library.
`irfpy.util.profile`	A simple decorator for profiling.
`irfpy.util.ringcache`	The module provide ring cache.
`irfpy.util.with_context`	With statement extension.
`irfpy.util.tk`	Tkinter helper module.