Commit c40c8571 authored by Philipp Frank's avatar Philipp Frank

added html and docktree files

parent e92a5247
Pipeline #12659 passed with stage
in 4 minutes and 33 seconds
This diff is collapsed.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview: module code &#8212; NIFTY 3.0.x documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.0.x',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>All modules for which code is available</h1>
<ul><li><a href="abc.html">abc</a></li>
<li><a href="nifty/field.html">nifty.field</a></li>
<li><a href="nifty/minimization/conjugate_gradient.html">nifty.minimization.conjugate_gradient</a></li>
<li><a href="nifty/minimization/descent_minimizer.html">nifty.minimization.descent_minimizer</a></li>
<li><a href="nifty/operators/composed_operator/composed_operator.html">nifty.operators.composed_operator.composed_operator</a></li>
<li><a href="nifty/operators/diagonal_operator/diagonal_operator.html">nifty.operators.diagonal_operator.diagonal_operator</a></li>
<li><a href="nifty/operators/fft_operator/fft_operator.html">nifty.operators.fft_operator.fft_operator</a></li>
<li><a href="nifty/operators/fft_operator/transformations/gllmtransformation.html">nifty.operators.fft_operator.transformations.gllmtransformation</a></li>
<li><a href="nifty/operators/fft_operator/transformations/hplmtransformation.html">nifty.operators.fft_operator.transformations.hplmtransformation</a></li>
<li><a href="nifty/operators/fft_operator/transformations/lmgltransformation.html">nifty.operators.fft_operator.transformations.lmgltransformation</a></li>
<li><a href="nifty/operators/fft_operator/transformations/lmhptransformation.html">nifty.operators.fft_operator.transformations.lmhptransformation</a></li>
<li><a href="nifty/operators/fft_operator/transformations/rgrgtransformation.html">nifty.operators.fft_operator.transformations.rgrgtransformation</a></li>
<li><a href="nifty/operators/invertible_operator_mixin/invertible_operator_mixin.html">nifty.operators.invertible_operator_mixin.invertible_operator_mixin</a></li>
<li><a href="nifty/operators/linear_operator/linear_operator.html">nifty.operators.linear_operator.linear_operator</a></li>
<li><a href="nifty/operators/projection_operator/projection_operator.html">nifty.operators.projection_operator.projection_operator</a></li>
<li><a href="nifty/operators/propagator_operator/propagator_operator.html">nifty.operators.propagator_operator.propagator_operator</a></li>
<li><a href="nifty/operators/response_operator/response_operator.html">nifty.operators.response_operator.response_operator</a></li>
<li><a href="nifty/operators/smoothing_operator/smoothing_operator.html">nifty.operators.smoothing_operator.smoothing_operator</a></li>
<li><a href="nifty/spaces/gl_space/gl_space.html">nifty.spaces.gl_space.gl_space</a></li>
<li><a href="nifty/spaces/hp_space/hp_space.html">nifty.spaces.hp_space.hp_space</a></li>
<li><a href="nifty/spaces/lm_space/lm_space.html">nifty.spaces.lm_space.lm_space</a></li>
<li><a href="nifty/spaces/power_space/power_space.html">nifty.spaces.power_space.power_space</a></li>
<li><a href="nifty/spaces/rg_space/rg_space.html">nifty.spaces.rg_space.rg_space</a></li>
<li><a href="nifty/spaces/space/space.html">nifty.spaces.space.space</a></li>
</ul>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/nifty_logo_black.png" alt="Logo"/>
</a></p><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, Theo Steininger.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
</div>
</body>
</html>
\ No newline at end of file
This source diff could not be displayed because it is too large. You can view the blob instead.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
.. currentmodule:: nifty
The ``ComposedOperator`` class -- ...
.....................................
.. autoclass:: ComposedOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``ConjugateGradient`` class -- ...
......................................
.. autoclass:: ConjugateGradient
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``DescentMinimizer`` class -- ...
.....................................
.. autoclass:: DescentMinimizer
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``DiagonalOperator`` class -- ...
.....................................
.. autoclass:: DiagonalOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``EndomorphicOperator`` class -- ...
........................................
.. autoclass:: EnomorphicOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``FFTOperator`` class -- ...
................................
.. autoclass:: FFTOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``Field`` class -- ...
..........................
.. autoclass:: Field
:show-inheritance:
:members:
.. rubric:: Methods
.. autoautosummary:: Field
:methods:
.. currentmodule:: nifty
The ``GLSpace`` class -- Gauss-Legendre pixelization of the sphere
..................................................................
.. autoclass:: GLSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``GLLMTransformation`` class -- ...
.......................................
.. autoclass:: GLLMTransformation
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``HPSpace`` class -- HEALPix discretization of the sphere
.............................................................
.. autoclass:: HPSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``HPLMTransformation`` class -- ...
.......................................
.. autoclass:: HPLMTransformation
:show-inheritance:
:members:
NIFTY -- Numerical Information Field Theory
===========================================
**NIFTY** [1]_, "\ **N**\umerical **I**\nformation **F**\ield **T**\heor\ **y**\ ", is a versatile library designed to enable the development of signal inference algorithms that operate regardless of the underlying spatial grid and its resolution. Its object-oriented framework is written in Python, although it accesses libraries written in Cython, C++, and C for efficiency.
NIFTY offers a toolkit that abstracts discretized representations of continuous spaces, fields in these spaces, and operators acting on fields into classes. Thereby, the correct normalization of operations on fields is taken care of automatically without concerning the user. This allows for an abstract formulation and programming of inference algorithms, including those derived within information field theory. Thus, NIFTY permits its user to rapidly prototype algorithms in 1D and then apply the developed code in higher-dimensional settings of real world problems. The set of spaces on which NIFTY operates comprises point sets, *n*-dimensional regular grids, spherical spaces, their harmonic counterparts, and product spaces constructed as combinations of those.
References
----------
.. [1] Selig et al., "NIFTY -- Numerical Information Field Theory -- a versatile Python library for signal inference", `A&A, vol. 554, id. A26 <http://dx.doi.org/10.1051/0004-6361/201321236>`_, 2013; `arXiv:1301.4499 <http://www.arxiv.org/abs/1301.4499>`_
.. note:: Parts of this publication can with or without modification be found within the source code and this online documentation for obvious reasons, and they are not explicitly marked as quotations.
Documentation
-------------
Welcome to NIFTY's documentation!
Contents
........
.. toctree::
:maxdepth: 1
spaces
operator
minimization
field
Indices and tables
..................
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. currentmodule:: nifty
The ``InvertibleOperatorMixin`` class -- ...
............................................
.. autoclass:: InvertibleOperatorMixin
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``LMSpace`` class -- Spherical Harmonics components
.......................................................
.. autoclass:: LMSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``LMGLTransformation`` class -- ...
.......................................
.. autoclass:: LMGLTransformation
:show-inheritance:
:members:
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment