-
Notifications
You must be signed in to change notification settings - Fork 0
/
drsrop_pipeline.html
181 lines (164 loc) · 14.3 KB
/
drsrop_pipeline.html
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
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>DRS-ROP Pipeline — liger_iris_pipeline v0.5.dev</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-astropy.css?v=9d21690f" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3b3f3827"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script type="text/javascript" src="_static/sidebar.js"></script>
<script type="text/javascript" src="_static/copybutton.js"></script>
<link rel="icon" href="_static/astropy_logo.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Data Quality (DQ) Initialization" href="dq_init/index.html" />
<link rel="prev" title="Available algorithms" href="available-steps.html" />
<link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600' rel='stylesheet' type='text/css'/>
</head><body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="index.html"><span id="logotext1">liger_iris_pipeline</span><span id="logotext2"></span><span id="logotext3">:docs</span></a>
<ul>
<li><a class="homelink" title="Astropy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="genindex.html">Index</a></li>
<li><a title="Module Index" href="py-modindex.html">Modules</a></li>
<li>
<form action="search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<a href="dq_init/index.html" title="Data Quality (DQ) Initialization">
next »
</a>
</li>
<li class="right">
<a href="available-steps.html" title="Available algorithms">
« previous
</a>
|
</li>
<li>
<a href="index.html">liger_iris_pipeline v0.5.dev</a>
»
</li>
<li><a href="available-steps.html" accesskey="U">Available algorithms</a> »</li>
<li>DRS-ROP Pipeline</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="drs-rop-pipeline">
<h1>DRS-ROP Pipeline<a class="headerlink" href="#drs-rop-pipeline" title="Link to this heading">¶</a></h1>
<p>The DRS_ROP Pipeline works on detector level readouts. The current steps implemented in the pipeline are
- Non-linearity Correction
- Detector Readout Sampling</p>
<section id="non-linearity-correction">
<h2>Non-linearity Correction<a class="headerlink" href="#non-linearity-correction" title="Link to this heading">¶</a></h2>
<p>Non-linearity correction step corrects for the non-linear response of the detector to incoming flux. This step is executed before sampling algorithms.</p>
</section>
<section id="detector-readout-sampling">
<h2>Detector Readout Sampling<a class="headerlink" href="#detector-readout-sampling" title="Link to this heading">¶</a></h2>
<p>The H4RG detecors are readout in non-destructive reads and sampling algorithms are used to estimate the accumulated electrons in the detector for an integration time. The sampling algorithms currently implemented in the pipeline are
- Correlated Double Sampling
- Multi Correlated Double Sampling
- Up-the-Ramp Sampling</p>
</section>
<section id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Link to this heading">¶</a></h2>
<p>The sampling algorithms use the drsrop_clib module.
<a class="reference external" href="https://github.com/oirlab/iris_readout">https://github.com/oirlab/iris_readout</a></p>
</section>
<section id="running-the-examples">
<h2>Running the Examples<a class="headerlink" href="#running-the-examples" title="Link to this heading">¶</a></h2>
<p>There is a example run in the liger_iris_pipeline/readout/tests directory. The sample ramp is given in the sample_ramp.fits.
sampling.cfg gives the configurations for the pipeline</p>
<p><code class="docutils literal notranslate"><span class="pre">sampling.cfg</span></code>:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="na">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"rop"</span>
<span class="na">class</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"liger_iris_pipeline.pipeline.ROPPipeline"</span>
<span class="na">save_results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span>
<span class="w"> </span><span class="k">[steps]</span>
<span class="w"> </span><span class="k">[[nonlincorr]]</span>
<span class="w"> </span><span class="k">[[readoutsamp]]</span>
<span class="w"> </span><span class="na">mode</span><span class="o">=</span><span class="s">'mcds'</span>
</pre></div>
</div>
<p>The sampling mode is set by the <code class="docutils literal notranslate"><span class="pre">mode</span></code> keyword which can be <code class="docutils literal notranslate"><span class="pre">mcds</span></code> or <code class="docutils literal notranslate"><span class="pre">utr</span></code>. MCDS algorithm also requires the group number, the number of reads to be co-added. This is currently hardcoded in this version.</p>
</section>
<section id="execute-the-pipeline-from-the-command-line">
<h2>Execute the pipeline from the command line<a class="headerlink" href="#execute-the-pipeline-from-the-command-line" title="Link to this heading">¶</a></h2>
<p>We can use <code class="docutils literal notranslate"><span class="pre">strun</span></code> from a terminal to execute the pipeline:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">tmtrun</span> <span class="n">sampling</span><span class="o">.</span><span class="n">cfg</span> <span class="n">sample_ramp</span><span class="o">.</span><span class="n">fits</span>
</pre></div>
</div>
<p>here is the output log:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,309<span class="w"> </span>-<span class="w"> </span>stpipe.rop<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>ROPPipeline<span class="w"> </span>instance<span class="w"> </span>created.
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,310<span class="w"> </span>-<span class="w"> </span>stpipe.rop.nonlincorr<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>NonlincorrStep<span class="w"> </span>instance<span class="w"> </span>created.
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,311<span class="w"> </span>-<span class="w"> </span>stpipe.rop.readoutsamp<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>ReadoutsampStep<span class="w"> </span>instance<span class="w"> </span>created.
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,311<span class="w"> </span>-<span class="w"> </span>stpipe<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Hostname:<span class="w"> </span>arun-ThinkPad-X1-Carbon-6th
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,311<span class="w"> </span>-<span class="w"> </span>stpipe<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>OS:<span class="w"> </span>Linux
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,335<span class="w"> </span>-<span class="w"> </span>stpipe.rop<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Step<span class="w"> </span>rop<span class="w"> </span>running<span class="w"> </span>with<span class="w"> </span>args<span class="w"> </span><span class="o">(</span><span class="s1">'sample_ramp.fits'</span>,<span class="o">)</span>.
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,335<span class="w"> </span>-<span class="w"> </span>stpipe.rop<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Starting<span class="w"> </span>ROP<span class="w"> </span>Pipeline<span class="w"> </span>...
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,499<span class="w"> </span>-<span class="w"> </span>stpipe.rop.nonlincorr<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Step<span class="w"> </span>nonlincorr<span class="w"> </span>running<span class="w"> </span>with<span class="w"> </span>args<span class="w"> </span><span class="o">(</span><RampModel<span class="o">(</span><span class="m">1</span>,<span class="w"> </span><span class="m">4</span>,<span class="w"> </span><span class="m">10</span>,<span class="w"> </span><span class="m">10</span><span class="o">)</span><span class="w"> </span>from<span class="w"> </span>sample_ramp.fits>,<span class="o">)</span>.
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,577<span class="w"> </span>-<span class="w"> </span>stpipe.rop.nonlincorr<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Step<span class="w"> </span>nonlincorr<span class="w"> </span><span class="k">done</span>
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,603<span class="w"> </span>-<span class="w"> </span>stpipe.rop.readoutsamp<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Step<span class="w"> </span>readoutsamp<span class="w"> </span>running<span class="w"> </span>with<span class="w"> </span>args<span class="w"> </span><span class="o">(</span><RampModel<span class="o">(</span><span class="m">1</span>,<span class="w"> </span><span class="m">4</span>,<span class="w"> </span><span class="m">10</span>,<span class="w"> </span><span class="m">10</span><span class="o">)</span><span class="w"> </span>from<span class="w"> </span>sample_ramp.fits>,<span class="o">)</span>.
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,618<span class="w"> </span>-<span class="w"> </span>stpipe.rop.readoutsamp<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>MCDS<span class="w"> </span>Sampling<span class="w"> </span>Selected
<span class="o">(</span><span class="m">10</span>,<span class="w"> </span><span class="m">10</span><span class="o">)</span>
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,640<span class="w"> </span>-<span class="w"> </span>stpipe.rop.readoutsamp<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Step<span class="w"> </span>readoutsamp<span class="w"> </span><span class="k">done</span>
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,665<span class="w"> </span>-<span class="w"> </span>stpipe.rop<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Saved<span class="w"> </span>model<span class="w"> </span><span class="k">in</span><span class="w"> </span>sample_rop.fits
<span class="m">2019</span>-04-26<span class="w"> </span><span class="m">10</span>:09:21,665<span class="w"> </span>-<span class="w"> </span>stpipe.rop<span class="w"> </span>-<span class="w"> </span>INFO<span class="w"> </span>-<span class="w"> </span>Step<span class="w"> </span>rop<span class="w"> </span><span class="k">done</span>
</pre></div>
</div>
<p>This creates a sample_rop.fits file in the working directory that is the processed</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">DRS-ROP Pipeline</a><ul>
<li><a class="reference internal" href="#non-linearity-correction">Non-linearity Correction</a></li>
<li><a class="reference internal" href="#detector-readout-sampling">Detector Readout Sampling</a></li>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#running-the-examples">Running the Examples</a></li>
<li><a class="reference internal" href="#execute-the-pipeline-from-the-command-line">Execute the pipeline from the command line</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="https://github.com/oirlab/liger_iris_pipeline/tree/master/docs/drsrop_pipeline.rst">Edit This Page on Github</a>
<a href="_sources/drsrop_pipeline.rst.txt"
rel="nofollow">Page Source</a>
<a href="#">Back to Top</a></p>
<p>
© Copyright 2024, Andrea Zonca, Arun Surya, Bryson Cale.<br/>
Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 8.0.2.
Last built 02 Sep 2024. <br/>
</p>
</footer>
</body>
</html>