code.rst 18.1 KB
Newer Older
1

Martin Reinecke's avatar
Martin Reinecke committed
2
=============
3
4
Code Overview
=============
5

Martin Reinecke's avatar
Martin Reinecke committed
6
7
8
9

Executive summary
=================

10
11
The fundamental building blocks required for IFT computations are best
recognized from a large distance, ignoring all technical details.
12

13
14
From such a perspective,

Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
15
- IFT problems largely consist of the combination of several high dimensional
16
  *minimization* problems.
Philipp Arras's avatar
Philipp Arras committed
17
- Within NIFTy, *operators* are used to define the characteristic equations and
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
18
  properties of the problems.
Martin Reinecke's avatar
Martin Reinecke committed
19
20
- The equations are built mostly from the application of *linear operators*,
  but there may also be nonlinear functions involved.
21
- The unknowns in the equations represent either continuous physical *fields*,
Martin Reinecke's avatar
Martin Reinecke committed
22
23
24
25
  or they are simply individual measured *data points*.
- Discretized *fields* have geometrical information (like locations and volume
  elements) associated with every entry; this information is called the field's
  *domain*.
26
27
28
29
30
31
32
33
34
35
36
37
38

In the following sections, the concepts briefly presented here will be
discussed in more detail; this is done in reversed order of their introduction,
to avoid forward references.


Domains
=======


Abstract base class
-------------------

39
40
.. currentmodule:: nifty5.domains.domain

Philipp Arras's avatar
Philipp Arras committed
41
One of the fundamental building blocks of the NIFTy5 framework is the *domain*.
42
Its required capabilities are expressed by the abstract :py:class:`Domain` class.
43
A domain must be able to answer the following queries:
44
m
45
46
47
48
49
50
51
52
53
54
55

- its total number of data entries (pixels), which is accessible via the
  :attr:`~Domain.size` property
- the shape of the array that is supposed to hold these data entries
  (obtainable by means of the :attr:`~Domain.shape` property)
- equality comparison to another :class:`Domain` instance


Unstructured domains
--------------------

56
57
.. currentmodule:: nifty5.domains.unstructured_domain

58
59
60
61
62
63
64
65
66
67
68
Domains can be either *structured* (i.e. there is geometrical information
associated with them, like position in space and volume factors),
or *unstructured* (meaning that the data points have no associated manifold).

Unstructured domains can be described by instances of NIFTy's
:class:`UnstructuredDomain` class.


Structured domains
------------------

69
70
.. currentmodule:: nifty5.domains.structured_domain

71
72
73
74
75
In contrast to unstructured domains, these domains have an assigned geometry.
NIFTy requires them to provide the volume elements of their grid cells.
The additional methods are specified in the abstract class
:class:`StructuredDomain`:

Martin Reinecke's avatar
Martin Reinecke committed
76
- The properties :attr:`~StructuredDomain.scalar_dvol`,
77
78
79
80
81
82
83
84
85
86
87
88
89
  :attr:`~StructuredDomain.dvol`, and  :attr:`~StructuredDomain.total_volume`
  provide information about the domain's pixel volume(s) and its total volume.
- The property :attr:`~StructuredDomain.harmonic` specifies whether a domain
  is harmonic (i.e. describes a frequency space) or not
- Iff the domain is harmonic, the methods
  :meth:`~StructuredDomain.get_k_length_array`,
  :meth:`~StructuredDomain.get_unique_k_lengths`, and
  :meth:`~StructuredDomain.get_fft_smoothing_kernel_function` provide absolute
  distances of the individual grid cells from the origin and assist with
  Gaussian convolution.

NIFTy comes with several concrete subclasses of :class:`StructuredDomain`:

90
91
92
.. currentmodule:: nifty5.domains

- :class:`rg_space.RGSpace` represents a regular Cartesian grid with an arbitrary
93
  number of dimensions, which is supposed to be periodic in each dimension.
94
95
- :class:`hp_space.HPSpace` and :class:`gl_space.GLSpace` describe pixelisations of the
  2-sphere; their counterpart in harmonic space is :class:`lm_space.LMSpace`, which
96
  contains spherical harmonic coefficients.
97
- :class:`power_space.PowerSpace` is used to describe one-dimensional power spectra.
98

99
100
Among these, :class:`rg_space.RGSpace` can be harmonic or not (depending on constructor arguments), :class:`gl_space.GLSpace`, :class:`hp_space.HPSpace`, and :class:`power_space.PowerSpace` are
pure position domains (i.e. nonharmonic), and :class:`lm_space.LMSpace` is always
101
102
103
104
105
106
107
harmonic.


Combinations of domains
=======================

The fundamental classes described above are often sufficient to specify the
108
109
domain of a field. In some cases, however, it will be necessary to define the
field on a product of elementary domains instead of a single one.
Philipp Arras's avatar
Philipp Arras committed
110
More sophisticated operators also require a set of several such fields.
111
112
113
114
115
Some examples are:

- sky emission depending on location and energy. This could be represented by
  a product of an :class:`HPSpace` (for location) with an :class:`RGSpace`
  (for energy).
Philipp Arras's avatar
Philipp Arras committed
116
- a polarized field, which could be modeled as a product of any structured
Martin Reinecke's avatar
Martin Reinecke committed
117
118
  domain (representing location) with a four-element
  :class:`UnstructuredDomain` holding Stokes I, Q, U and V components.
Martin Reinecke's avatar
Martin Reinecke committed
119
120
121
- a model for the sky emission, which holds both the current realization
  (on a harmonic domain) and a few inferred model parameters (e.g. on an
  unstructured grid).
122
123
124
125
126
127

Consequently, NIFTy defines a class called :class:`DomainTuple` holding
a sequence of :class:`Domain` objects, which is used to specify full field
domains. In principle, a :class:`DomainTuple` can even be empty, which implies
that the field living on it is a scalar.

Martin Reinecke's avatar
Martin Reinecke committed
128
129
130
131
A :class:`DomainTuple` supports iteration and indexing, and also provides the
properties :attr:`~DomainTuple.shape`, :attr:`~DomainTuple.size` in analogy to
the elementary :class:`Domain`.

Torsten Ensslin's avatar
Torsten Ensslin committed
132
An aggregation of several :class:`DomainTuple` s, each member identified by a
Martin Reinecke's avatar
Martin Reinecke committed
133
name, is described by the :class:`MultiDomain` class.
134
135
136
137

Fields
======

Martin Reinecke's avatar
Martin Reinecke committed
138
139
140
Fields on a single DomainTuple
------------------------------

141
142
143
144
145
146
A :class:`Field` object consists of the following components:

- a domain in form of a :class:`DomainTuple` object
- a data type (e.g. numpy.float64)
- an array containing the actual values

Martin Reinecke's avatar
Martin Reinecke committed
147
Usually, the array is stored in the form of a ``numpy.ndarray``, but for very
Martin Reinecke's avatar
Martin Reinecke committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
resource-intensive tasks NIFTy also provides an alternative storage method to
be used with distributed memory processing.

Fields support a wide range of arithmetic operations, either involving two
fields with equal domains, or a field and a scalar.
Contractions (like summation, integration, minimum/maximum, computation of
statistical moments) can be carried out either over an entire field (producing
a scalar result) or over sub-domains (resulting in a field living on a smaller
domain). Scalar products of two fields can also be computed easily.

There is also a set of convenience functions to generate fields with constant
values or fields filled with random numbers according to a user-specified
distribution.

Martin Reinecke's avatar
Martin Reinecke committed
162
163
164
165
166
Like almost all NIFTy objects, fields are immutable: their value or any other
attribute cannot be modified after construction. To manipulate a field in ways
that are not covered by the provided standard operations, its data content must
be extracted first, then changed, and a new field has to be created from the
result.
Martin Reinecke's avatar
Martin Reinecke committed
167

168
Fields defined on a MultiDomain
Philipp Arras's avatar
Philipp Arras committed
169
-------------------------------
Martin Reinecke's avatar
Martin Reinecke committed
170
171

The :class:`MultiField` class can be seen as a dictionary of individual
172
:class:`Field` s, each identified by a name, which is defined on a
Martin Reinecke's avatar
Martin Reinecke committed
173
174
175
176
177
178
179
180
:class:`MultiDomain`.


Operators
=========

All transformations between different NIFTy fields are expressed  (explicitly
or implicitly) in the form of :class:`Operator` objects. The interface of this
Torsten Ensslin's avatar
Torsten Ensslin committed
181
class is very minimalistic: it has a property called :class:`domain` which returns
182
a :class:`DomainTuple` or :class:`MultiDomain` object specifying the structure of the
Torsten Ensslin's avatar
Torsten Ensslin committed
183
:class:`Field` s or :class:`MultiField` s it expects as input, another property :class:`target`
Martin Reinecke's avatar
Martin Reinecke committed
184
185
186
describing its output, and finally an overloaded `apply` method, which can
take

Torsten Ensslin's avatar
Torsten Ensslin committed
187
188
189
190
- a :class:`Field`/:class:`MultiField`object, in which case it returns the transformed
  :class:`Field`/:class:`MultiField`
- a :class:`Linearization` object, in which case it returns the transformed
  :class:`Linearization`
Martin Reinecke's avatar
Martin Reinecke committed
191

Torsten Ensslin's avatar
Torsten Ensslin committed
192
193
194
195
This is the interface that all objects derived from :class:`Operator` must implement.
In addition, :class:`Operator` objects can be added/subtracted, multiplied, chained
(via the :class:`__call__` method) and support pointwise application of functions like
:class:`exp()`, :class:`log()`, :class:`sqrt()`, :class:`conjugate()` etc.
Martin Reinecke's avatar
Martin Reinecke committed
196

197
198
199
200

Linear Operators
================

Philipp Arras's avatar
Philipp Arras committed
201
A linear operator (represented by NIFTy5's abstract :class:`LinearOperator`
Martin Reinecke's avatar
Martin Reinecke committed
202
203
class) is derived from `Operator` and can be interpreted as an
(implicitly defined) matrix. Since its operation is linear, it can provide some
Torsten Ensslin's avatar
Torsten Ensslin committed
204
additional functionality which is not available for the more generic :class:`Operator`
Martin Reinecke's avatar
Martin Reinecke committed
205
class.
206

Martin Reinecke's avatar
Martin Reinecke committed
207
208
209
210

Operator basics
---------------

211
212
There are four basic ways of applying an operator :math:`A` to a field :math:`f`:

Martin Reinecke's avatar
Martin Reinecke committed
213
214
215
216
- direct application: :math:`A\cdot f`
- adjoint application: :math:`A^\dagger \cdot f`
- inverse application: :math:`A^{-1}\cdot f`
- adjoint inverse application: :math:`(A^\dagger)^{-1}\cdot f`
217

Martin Reinecke's avatar
Martin Reinecke committed
218
219
(Because of the linearity, inverse adjoint and adjoint inverse application
are equivalent.)
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235

These different actions of an operator ``Op`` on a field ``f`` can be invoked
in various ways:

- direct multiplication: ``Op(f)`` or ``Op.times(f)`` or ``Op.apply(f, Op.TIMES)``
- adjoint multiplication: ``Op.adjoint_times(f)`` or ``Op.apply(f, Op.ADJOINT_TIMES)``
- inverse multiplication: ``Op.inverse_times(f)`` or ``Op.apply(f, Op.INVERSE_TIMES)``
- adjoint inverse multiplication: ``Op.adjoint_inverse_times(f)`` or ``Op.apply(f, Op.ADJOINT_INVERSE_TIMES)``

Operator classes defined in NIFTy may implement an arbitrary subset of these
four operations. This subset can be queried using the
:attr:`~LinearOperator.capability` property.

If needed, the set of supported operations can be enhanced by iterative
inversion methods;
for example, an operator defining direct and adjoint multiplication could be
Martin Reinecke's avatar
Martin Reinecke committed
236
enhanced by this approach to support the complete set. This functionality is
237
238
239
240
241
242
243
244
245
246
247
248
249
250
provided by NIFTy's :class:`InversionEnabler` class, which is itself a linear
operator.

Direct multiplication and adjoint inverse multiplication transform a field
living on the operator's :attr:`~LinearOperator.domain` to one living on the operator's :attr:`~LinearOperator.target`, whereas adjoint multiplication
and inverse multiplication transform from :attr:`~LinearOperator.target` to :attr:`~LinearOperator.domain`.

Operators with identical domain and target can be derived from
:class:`EndomorphicOperator`; typical examples for this category are the :class:`ScalingOperator`, which simply multiplies its input by a scalar
value, and :class:`DiagonalOperator`, which multiplies every value of its input
field with potentially different values.

Further operator classes provided by NIFTy are

Martin Reinecke's avatar
Martin Reinecke committed
251
252
- :class:`HarmonicTransformOperator` for transforms from a harmonic domain to
  its counterpart in position space, and their adjoint
253
- :class:`PowerDistributor` for transforms from a :class:`PowerSpace` to
Martin Reinecke's avatar
Martin Reinecke committed
254
  an associated harmonic domain, and their adjoint
255
256
257
258
- :class:`GeometryRemover`, which transforms from structured domains to
  unstructured ones. This is typically needed when building instrument response
  operators.

Martin Reinecke's avatar
Martin Reinecke committed
259

Martin Reinecke's avatar
Martin Reinecke committed
260
261
Syntactic sugar
---------------
Martin Reinecke's avatar
Martin Reinecke committed
262

Martin Reinecke's avatar
Martin Reinecke committed
263
Nifty5 allows simple and intuitive construction of altered and combined
264
265
operators.
As an example, if ``A``, ``B`` and ``C`` are of type :class:`LinearOperator`
Martin Reinecke's avatar
Martin Reinecke committed
266
and ``f1`` and ``f2`` are of type :class:`Field`, writing::
267

Martin Reinecke's avatar
Martin Reinecke committed
268
    X = A(B.inverse(A.adjoint)) + C
269
270
271
272
273
274
275
276
277
278
279
    f2 = X(f1)

will perform the operation suggested intuitively by the notation, checking
domain compatibility while building the composed operator.
The combined operator infers its domain and target from its constituents,
as well as the set of operations it can support.
The properties :attr:`~LinearOperator.adjoint` and
:attr:`~LinearOperator.inverse` return a new operator which behaves as if it
were the original operator's adjoint or inverse, respectively.


Philipp Arras's avatar
Philipp Arras committed
280
281
Operators
=========
282

Philipp Arras's avatar
Philipp Arras committed
283
Operator classes (represented by NIFTy5's abstract :class:`Operator` class) are used to construct
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
284
the equations of a specific inference problem.
Philipp Arras's avatar
Philipp Arras committed
285
Most operators are defined via a position, which is a :class:`MultiField` object,
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
286
their value at this position, which is again a :class:`MultiField` object and a Jacobian derivative,
287
which is a :class:`LinearOperator` and is needed for the minimization procedure.
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
288

Philipp Arras's avatar
Philipp Arras committed
289
Using the existing basic operator classes one can construct more complicated operators, as
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
290
NIFTy allows for easy and self-consinstent combination via point-wise multiplication,
Philipp Arras's avatar
Philipp Arras committed
291
addition and subtraction. The operator resulting from these operations then automatically
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
292
293
294
295
contains the correct Jacobians, positions and values.
Notably, :class:`Constant` and :class:`Variable` allow for an easy way to turn
inference of specific quantities on and off.

Philipp Arras's avatar
Philipp Arras committed
296
The basic operator classes also allow for more complex operations on operators such as
297
the application of :class:`LinearOperators` or local non-linearities.
Philipp Arras's avatar
Philipp Arras committed
298
299
As an example one may consider the following combination of ``x``, which is an operator of type
:class:`Variable` and ``y``, which is an operator of type :class:`Constant`::
300

Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
301
	z = x*x + y
302

Philipp Arras's avatar
Philipp Arras committed
303
``z`` will then be an operator with the following properties::
304
305

	z.value = x.value*x.value + y.value
Martin Reinecke's avatar
Martin Reinecke committed
306
	z.position = Union(x.position, y.position)
307
308
309
	z.jacobian = 2*makeOp(x.value)


Philipp Arras's avatar
Philipp Arras committed
310
Basic operators
Philipp Arras's avatar
Philipp Arras committed
311
---------------
Philipp Arras's avatar
Philipp Arras committed
312
# FIXME All this is outdated!
313

Philipp Arras's avatar
Philipp Arras committed
314
Basic operator classes provided by NIFTy are
315

Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
316
- :class:`Constant` contains a constant value and has a zero valued Jacobian.
Philipp Arras's avatar
Philipp Arras committed
317
  Like other operators, it has a position, but its value does not depend on it.
318
319
320
- :class:`Variable` returns the position as its value, its derivative is one.
- :class:`LinearModel` applies a :class:`LinearOperator` on the model.
- :class:`LocalModel` applies a non-linearity locally on the model.
Martin Reinecke's avatar
Martin Reinecke committed
321
	value and Jacobian are combined into corresponding :class:`MultiFields` and operators.
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
322

323

Philipp Arras's avatar
Philipp Arras committed
324
325
Advanced operators
------------------
326

Philipp Arras's avatar
Philipp Arras committed
327
NIFTy also provides a library of more sophisticated operators which are used for more
328
329
specific inference problems. Currently these are:

Philipp Arras's avatar
Philipp Arras committed
330
331
332
- :class:`AmplitudeOperator`, which returns a smooth power spectrum.
- :class:`InverseGammaOperator`, which models point sources which follow a inverse gamma distribution.
- :class:`CorrelatedField`, which models a diffuse log-normal field. It takes an amplitude operator
333
334
335
	to specify the correlation structure of the field.


336
337
.. _minimization:

Martin Reinecke's avatar
Martin Reinecke committed
338

339
340
341
Minimization
============

Martin Reinecke's avatar
Martin Reinecke committed
342
343
344
345
346
347
Most problems in IFT are solved by (possibly nested) minimizations of
high-dimensional functions, which are often nonlinear.


Energy functionals
------------------
348

Philipp Arras's avatar
Philipp Arras committed
349
In NIFTy5 such functions are represented by objects of type :class:`Energy`.
Martin Reinecke's avatar
Martin Reinecke committed
350
351
These hold the prescription how to calculate the function's
:attr:`~Energy.value`, :attr:`~Energy.gradient` and
Martin Reinecke's avatar
Martin Reinecke committed
352
(optionally) :attr:`~Energy.metric` at any given :attr:`~Energy.position`
Martin Reinecke's avatar
Martin Reinecke committed
353
in parameter space.
Martin Reinecke's avatar
Martin Reinecke committed
354
Function values are floating-point scalars, gradients have the form of fields
Martin Reinecke's avatar
Martin Reinecke committed
355
living on the energy's position domain, and metrics are represented by
Martin Reinecke's avatar
Martin Reinecke committed
356
linear operator objects.
357

Martin Reinecke's avatar
Martin Reinecke committed
358
359
Energies are classes that typically have to be provided by the user when
tackling new IFT problems.
Philipp Arras's avatar
Philipp Arras committed
360
Some examples of concrete energy classes delivered with NIFTy5 are
Martin Reinecke's avatar
Martin Reinecke committed
361
:class:`QuadraticEnergy` (with position-independent metric, mainly used with
Philipp Arras's avatar
Philipp Arras committed
362
conjugate gradient minimization) and :class:`~nifty5.library.WienerFilterEnergy`.
363

Martin Reinecke's avatar
Martin Reinecke committed
364
365
366

Iteration control
-----------------
Martin Reinecke's avatar
Martin Reinecke committed
367
368

Iterative minimization of an energy reqires some means of
Martin Reinecke's avatar
Martin Reinecke committed
369
checking the quality of the current solution estimate and stopping once
Martin Reinecke's avatar
Martin Reinecke committed
370
371
372
it is sufficiently accurate. In case of numerical problems, the iteration needs
to be terminated as well, returning a suitable error description.

Philipp Arras's avatar
Philipp Arras committed
373
In NIFTy5, this functionality is encapsulated in the abstract
Martin Reinecke's avatar
Martin Reinecke committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
:class:`IterationController` class, which is provided with the initial energy
object before starting the minimization, and is updated with the improved
energy after every iteration. Based on this information, it can either continue
the minimization or return the current estimate indicating convergence or
failure.

Sensible stopping criteria can vary significantly with the problem being
solved; NIFTy provides one concrete sub-class of :class:`IterationController`
called :class:`GradientNormController`, which should be appropriate in many
circumstances, but users have complete freedom to implement custom sub-classes
for their specific applications.


Minimization algorithms
-----------------------

Martin Reinecke's avatar
Martin Reinecke committed
390
391
392
393
394
395
396
397
398
399
400
401
402
All minimization algorithms in NIFTy inherit from the abstract
:class:`Minimizer` class, which presents a minimalistic interface consisting
only of a :meth:`~Minimizer.__call__` method taking an :class:`Energy` object
and optionally a preconditioning operator, and returning the energy at the
discovered minimum and a status code.

For energies with a quadratic form (i.e. which
can be expressed by means of a :class:`QuadraticEnergy` object), an obvious
choice of algorithm is the :class:`ConjugateGradient` minimizer.

A similar algorithm suited for nonlinear problems is provided by
:class:`NonlinearCG`.

Martin Reinecke's avatar
Martin Reinecke committed
403
Many minimizers for nonlinear problems can be characterized as
Martin Reinecke's avatar
Martin Reinecke committed
404
405
406
407
408
409
410
411
412

- first deciding on a direction for the next step
- then finding a suitable step length along this direction, resulting in the
  next energy estimate.

This family of algorithms is encapsulated in NIFTy's :class:`DescentMinimizer`
class, which currently has three concrete implementations:
:class:`SteepestDescent`, :class:`VL_BFGS`, and :class:`RelaxedNewton`.
Of these algorithms, only :class:`RelaxedNewton` requires the energy object to
Martin Reinecke's avatar
Martin Reinecke committed
413
provide a :attr:`~Energy.metric` property, the others only need energy
Martin Reinecke's avatar
Martin Reinecke committed
414
415
values and gradients.

Martin Reinecke's avatar
Martin Reinecke committed
416
417
418
419
420
The flexibility of NIFTy's design allows using externally provided
minimizers. With only small effort, adapters for two SciPy minimizers were
written; they are available under the names :class:`NewtonCG` and
:class:`L_BFGS_B`.

Martin Reinecke's avatar
Martin Reinecke committed
421
422
423
424

Application to operator inversion
---------------------------------

Martin Reinecke's avatar
Martin Reinecke committed
425
426
427
428
429
430
431
432
433
434
It is important to realize that the machinery presented here cannot only be
used for minimizing IFT Hamiltonians, but also for the numerical inversion of
linear operators, if the desired application mode is not directly available.
A classical example is the information propagator

:math:`D = \left(R^\dagger N^{-1} R + S^{-1}\right)^{-1}`,

which must be applied when calculating a Wiener filter. Only its inverse
application is straightforward; to use it in forward direction, we make use
of NIFTy's :class:`InversionEnabler` class, which internally performs a
Martin Reinecke's avatar
Martin Reinecke committed
435
minimization of a :class:`QuadraticEnergy` by means of the
Martin Reinecke's avatar
Martin Reinecke committed
436
:class:`ConjugateGradient` algorithm.