Commit ad44ca0a authored by Martin Reinecke's avatar Martin Reinecke
Browse files

remove docs

parent 11da9bf9
.. currentmodule:: nifty
The ``ComposedOperator`` class -- NIFTY class for composed operators
....................................................................
.. autoclass:: ComposedOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``DiagonalOperator`` class -- NIFTY class for diagonal operators
....................................................................
.. autoclass:: DiagonalOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``EndomorphicOperator`` class -- ...
........................................
.. autoclass:: EndomorphicOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``FFTOperator`` class -- Transforms between a pair of position and harmonic domains
.......................................................................................
.. autoclass:: FFTOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``InvertibleOperatorMixin`` class -- Mixin class to invert implicit defined operators
.........................................................................................
.. autoclass:: InvertibleOperatorMixin
:show-inheritance:
:members:
Operators
=========
Operators perform some operation on a given field. In practice an operator can
take the form of an explicit matrix (e.g. stored in a Numpy array) or it may be
implicitly defined as a function (e.g. an FFT operation would not be encoded in
a matrix, but performed using an FFT routine). NIFTY includes a framework for
handling arbitrary operators, and basic methods for manipulating these
operators. Common functions like taking traces and extracting diagonals are
provided.
In order to have a blueprint for operators capable of handling fields, any
application of operators is split into a general and a concrete part. The
general part comprises the correct involvement of normalizations and
transformations, necessary for any operator type, while the concrete part is
unique for each operator subclass. In analogy to the field class, any operator
instance has a set of properties that specify its domain and target as well as
some additional flags.
Operator classes
----------------
NIFTY provides a base class for defining operators, as well as several pre-implemented operator types that are very often needed for signal inference
algorithms.
.. toctree::
:maxdepth: 1
diagonal_operator
fft_operator
composed_operator
response_operator
smoothing_operator
projection_operator
propagator_operator
endomorphic_operator
invertible_operator_mixin
.. currentmodule:: nifty
The ``LinearOperator`` class -- The base Operator Object
--------------------------------------------------------
.. autoclass:: LinearOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``ProjectionOperator`` class -- NIFTY class for projection operators
........................................................................
.. autoclass:: ProjectionOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``PropagatorOperator`` class -- NIFTY Propagator Operator D
...............................................................
.. autoclass:: PropagatorOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``ResponseOperator`` class -- NIFTy ResponseOperator (example)
..................................................................
.. autoclass:: ResponseOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``SmoothingOperator`` class -- NIFTY class for smoothing operators
......................................................................
.. autoclass:: SmoothingOperator
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``GLSpace`` class -- Gauss-Legendre pixelization of the sphere
..................................................................
.. autoclass:: GLSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``GLLMTransformation`` class -- A transformation routine
............................................................
.. 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 -- A transformation routine
............................................................
.. autoclass:: HPLMTransformation
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``LMSpace`` class -- Spherical Harmonics components
.......................................................
.. autoclass:: LMSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``LMGLTransformation`` class -- A transformation routine
............................................................
.. autoclass:: LMGLTransformation
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``LMHPTransformation`` class -- A transformation routine
............................................................
.. autoclass:: LMHPTransformation
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``PowerSpace`` class -- NIFTY class for spaces of power spectra
....................................................................
.. autoclass:: PowerSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``RGSpace`` class -- Regular Cartesian grids
................................................
.. autoclass:: RGSpace
:show-inheritance:
:members:
.. currentmodule:: nifty
The ``RGRGTransformation`` class -- A transformation routine
............................................................
.. autoclass:: RGRGTransformation
:show-inheritance:
:members:
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