composed_operator.html 12.4 KB
Newer Older
Philipp Frank's avatar
Philipp Frank committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

<!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>The ComposedOperator class – … &#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="next" title="The ResponseOperator class – …" href="response_operator.html" />
    <link rel="prev" title="The FFTOperator class – …" href="fft_operator.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">
            
  <div class="section" id="the-composedoperator-class">
<h1>The <code class="docutils literal"><span class="pre">ComposedOperator</span></code> class – …<a class="headerlink" href="#the-composedoperator-class" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="nifty.ComposedOperator">
<em class="property">class </em><code class="descclassname">nifty.</code><code class="descname">ComposedOperator</code><a class="reference internal" href="_modules/nifty/operators/composed_operator/composed_operator.html#ComposedOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nifty.ComposedOperator" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">nifty.operators.linear_operator.linear_operator.LinearOperator</span></code></p>
<p>NIFTY class for composed operators.</p>
<p>The  NIFTY composed operator class combines multiple linear operators.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>operators</strong> : tuple of NIFTy Operators</p>
<blockquote>
<div><p>The tuple of LinearOperators.</p>
</div></blockquote>
<p><strong>default_spaces</strong> : tuple of ints <em>optional</em></p>
<blockquote>
<div><p>Defines on which space(s) of a given field the Operator acts by
default (default: None)</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>TypeError</strong></p>
<blockquote class="last">
<div><dl class="docutils">
<dt>Raised if</dt>
<dd><ul class="first last simple">
<li>an element of the operator list is not an instance of the
LinearOperator-baseclass.</li>
</ul>
</dd>
</dl>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><code class="xref py py-obj docutils literal"><span class="pre">EndomorphicOperator</span></code>, <a class="reference internal" href="projection_operator.html#nifty.ProjectionOperator" title="nifty.ProjectionOperator"><code class="xref py py-obj docutils literal"><span class="pre">ProjectionOperator</span></code></a>, <a class="reference internal" href="diagonal_operator.html#nifty.DiagonalOperator" title="nifty.DiagonalOperator"><code class="xref py py-obj docutils literal"><span class="pre">DiagonalOperator</span></code></a>, <a class="reference internal" href="smoothing_operator.html#nifty.SmoothingOperator" title="nifty.SmoothingOperator"><code class="xref py py-obj docutils literal"><span class="pre">SmoothingOperator</span></code></a>, <a class="reference internal" href="response_operator.html#nifty.ResponseOperator" title="nifty.ResponseOperator"><code class="xref py py-obj docutils literal"><span class="pre">ResponseOperator</span></code></a>, <a class="reference internal" href="propagator_operator.html#nifty.PropagatorOperator" title="nifty.PropagatorOperator"><code class="xref py py-obj docutils literal"><span class="pre">PropagatorOperator</span></code></a>, <a class="reference internal" href="#nifty.ComposedOperator" title="nifty.ComposedOperator"><code class="xref py py-obj docutils literal"><span class="pre">ComposedOperator</span></code></a></p>
</div>
<p class="rubric">Notes</p>
<p>Very usefull in case one has to transform a Field living over a product
space (see example below).</p>
<p class="rubric">Examples</p>
<p>Minimal example of transforming a Field living on two domains into its
harmonic space.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">x1</span> <span class="o">=</span> <span class="n">RGSpace</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">x2</span> <span class="o">=</span> <span class="n">RGSpace</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">k1</span> <span class="o">=</span> <span class="n">RGRGTransformation</span><span class="o">.</span><span class="n">get_codomain</span><span class="p">(</span><span class="n">x1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">k2</span> <span class="o">=</span> <span class="n">RGRGTransformation</span><span class="o">.</span><span class="n">get_codomain</span><span class="p">(</span><span class="n">x2</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">FFT1</span> <span class="o">=</span> <span class="n">FFTOperator</span><span class="p">(</span><span class="n">domain</span><span class="o">=</span><span class="n">x1</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="n">k1</span><span class="p">,</span>
<span class="go">                       domain_dtype=np.float64, target_dtype=np.complex128)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">FFT2</span> <span class="o">=</span> <span class="n">FFTOperator</span><span class="p">(</span><span class="n">domain</span><span class="o">=</span><span class="n">x2</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="n">k2</span><span class="p">,</span>
<span class="go">                       domain_dtype=np.float64, target_dtype=np.complex128)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">FFT</span> <span class="o">=</span> <span class="n">ComposedOperator</span><span class="p">((</span><span class="n">FFT1</span><span class="p">,</span> <span class="n">FFT2</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="n">Field</span><span class="o">.</span><span class="n">from_random</span><span class="p">(</span><span class="s1">&#39;normal&#39;</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="p">(</span><span class="n">x1</span><span class="p">,</span><span class="n">x2</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">FFT</span><span class="o">.</span><span class="n">times</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
</pre></div>
</div>
<p class="rubric">Attributes</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#nifty.ComposedOperator.domain" title="nifty.ComposedOperator.domain"><code class="xref py py-obj docutils literal"><span class="pre">domain</span></code></a></td>
<td><em>domain</em> – tuple of DomainObjects, i.e. Spaces and FieldTypes</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#nifty.ComposedOperator.target" title="nifty.ComposedOperator.target"><code class="xref py py-obj docutils literal"><span class="pre">target</span></code></a></td>
<td><em>target</em> – tuple of DomainObjects, i.e. Spaces and FieldTypes</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#nifty.ComposedOperator.unitary" title="nifty.ComposedOperator.unitary"><code class="xref py py-obj docutils literal"><span class="pre">unitary</span></code></a></td>
<td><em>unitary</em> – boolean</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="nifty.ComposedOperator.domain">
<code class="descname">domain</code><a class="headerlink" href="#nifty.ComposedOperator.domain" title="Permalink to this definition"></a></dt>
<dd><p><em>domain</em> – tuple of DomainObjects, i.e. Spaces and FieldTypes
The domain on which the Operator’s input Field lives.
Every Operator which inherits from the abstract LinearOperator
base class must have this attribute.</p>
</dd></dl>

<dl class="attribute">
<dt id="nifty.ComposedOperator.target">
<code class="descname">target</code><a class="headerlink" href="#nifty.ComposedOperator.target" title="Permalink to this definition"></a></dt>
<dd><p><em>target</em> – tuple of DomainObjects, i.e. Spaces and FieldTypes
The domain on which the Operator’s output Field lives.
Every Operator which inherits from the abstract LinearOperator
base class must have this attribute.</p>
</dd></dl>

<dl class="attribute">
<dt id="nifty.ComposedOperator.unitary">
<code class="descname">unitary</code><a class="headerlink" href="#nifty.ComposedOperator.unitary" title="Permalink to this definition"></a></dt>
<dd><p><em>unitary</em> – boolean
States whether the Operator is unitary or not.
Every Operator which inherits from the abstract LinearOperator
base class must have this attribute.</p>
</dd></dl>

</dd></dl>

</div>


          </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>
  <li><a href="operator.html">Operators</a><ul>
      <li>Previous: <a href="fft_operator.html" title="previous chapter">The <code class="docutils literal"><span class="pre">FFTOperator</span></code> class – …</a></li>
      <li>Next: <a href="response_operator.html" title="next chapter">The <code class="docutils literal"><span class="pre">ResponseOperator</span></code> class – …</a></li>
  </ul></li>
  </ul></li>
</ul>
</div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/composed_operator.rst.txt"
            rel="nofollow">Show Source</a></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>
      
      |
      <a href="_sources/composed_operator.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>