1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2
3<!--Converted with LaTeX2HTML 2018.3 (Released July 19, 2018) -->
4<HTML lang="EN">
5<HEAD>
6<TITLE>ismoothing</TITLE>
7<META NAME="description" CONTENT="ismoothing">
8<META NAME="keywords" CONTENT="idl">
9<META NAME="resource-type" CONTENT="document">
10<META NAME="distribution" CONTENT="global">
11
12<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
13<META NAME="viewport" CONTENT="width=device-width, initial-scale=1.0">
14<META NAME="Generator" CONTENT="LaTeX2HTML v2018.3">
15   <link rel='apple-touch-icon' sizes='180x180' href='images/favicons/apple-touch-icon.png?v=2017'>
16   <link rel='icon' type='image/png' sizes='32x32' href='images/favicons/favicon-32x32.png?v=2017'>
17   <link rel='icon' type='image/png' sizes='16x16' href='images/favicons/favicon-16x16.png?v=2017'>
18   <link rel='manifest' href='images/favicons/manifest.json?v=2017'>
19   <link rel='mask-icon' href='images/favicons/safari-pinned-tab.svg?v=2017' color='#5bbad5'>
20   <link rel='shortcut icon' href='images/favicons/favicon.ico?v=2017'>
21   <meta name='apple-mobile-web-app-title' content='HEALPix'>
22   <meta name='application-name' content='HEALPix'>
23   <meta name='msapplication-config' content='images/favicons/browserconfig.xml?v=2017'>
24   <meta name='theme-color' content='#ffffff'>
25
26<LINK REL="STYLESHEET" HREF="idl.css">
27
28<LINK REL="next" HREF="idl_isynfast.htm">
29<LINK REL="previous" HREF="idl_iprocess_mask.htm">
30<LINK REL="next" HREF="idl_isynfast.htm">
31</HEAD>
32
33<body text="#000000" bgcolor="#FFFFFA">
34
35<DIV CLASS="navigation"><!--Navigation Panel-->
36<A
37 HREF="idl_iprocess_mask.htm">
38<IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A>
39<A
40 HREF="idl_HEALPix_IDL_subroutines.htm">
41<IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A>
42<A
43 HREF="idl_isynfast.htm">
44<IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A>
45<A ID="tex2html353"
46  HREF="idl_TABLE_CONTENTS.htm">
47<IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A>
48<BR>
49<B> Previous:</B> <A
50 HREF="idl_iprocess_mask.htm">iprocess_mask</A>
51
52<B>Up:</B> <A
53 HREF="idl_HEALPix_IDL_subroutines.htm">HEALPix/IDL subroutines</A>
54
55<B> Next:</B> <A
56 HREF="idl_isynfast.htm">isynfast</A>
57<B> Top:</B> <a href="main.htm">Main Page</a></DIV>
58<!--End of Navigation Panel-->
59
60<H1><A ID="SECTION4000"></A>
61<A ID="idl:ismoothing"></A>
62<BR>
63
64</H1>
65
66<P>
67<b><font size=+6><FONT COLOR="#CC0000">ismoothing</FONT></font></b><hr>
68<H3>This IDL facility provides an interface to F90 '<A HREF="./fac_smoothing.htm#fac:smoothing">smoothing</A>' facility. It can be
69used to smooth a <b>HEALPix</b> map by an arbitrary circular 'beam' defined by its
70Legendre window function (or its FWHM if it is assumed Gaussian)</H3>
71Location in HEALPix directory tree: <a href="https://sourceforge.net/p/healpix/code/1005/tree/trunk/src/idl/interfaces/ismoothing.pro"><b>src/idl/interfaces/ismoothing.pro</b></a>&nbsp;
72
73<P>
74<hr><h1>FORMAT </h1><h3>IDL>
75ISMOOTHING,
76<A HREF="#idl:ismoothing:map1_in">map1_in</A>,
77<A HREF="#idl:ismoothing:map2_out">map2_out</A>,[
78<A HREF="#idl:ismoothing:beam_file">beam_file=</A>,
79<A HREF="#idl:ismoothing:binpath">binpath=</A>,
80<A HREF="#idl:ismoothing:double">/double</A>,
81<A HREF="#idl:ismoothing:fwhm_arcmin">fwhm_arcmin=</A>,
82<A HREF="#idl:ismoothing:help">/help</A>,
83<A HREF="#idl:ismoothing:iter_order">iter_order=</A>,
84<A HREF="#idl:ismoothing:keep_tmp_files">keep_tmp_files=</A>,
85<A HREF="#idl:ismoothing:lmax">lmax=</A>,
86<A HREF="#idl:ismoothing:lmax">nlmax=</A>,
87<A HREF="#idl:ismoothing:nested">/nested</A>,
88<A HREF="#idl:ismoothing:ordering">ordering=</A>,
89<A HREF="#idl:ismoothing:plmfile">plmfile=</A>,
90<A HREF="#idl:ismoothing:regression">regression=</A>,
91<A HREF="#idl:ismoothing:ring">/ring</A>,
92<A HREF="#idl:ismoothing:simul_type">simul_type=</A>,
93<A HREF="#idl:ismoothing:silent">/silent</A>,
94<A HREF="#idl:ismoothing:theta_cut_deg">theta_cut_deg=</A>,
95<A HREF="#idl:ismoothing:tmpdir">tmpdir=</A>,
96<A HREF="#idl:ismoothing:won">/won</A>,
97<A HREF="#idl:ismoothing:w8file">w8file=</A>,
98<A HREF="#idl:ismoothing:w8dir">w8dir=</A>]
99</h3>
100
101<P>
102<hr>
103<H1>QUALIFIERS</H1>
104
105  <DL COMPACT><DT>
106<B>map1_in</B>
107<DD><A ID="idl:ismoothing:map1_in"></A> required input: input map, can be a FITS file, or a memory array containing the
108        map to smooth
109    <DT>
110<B>map2_out</B>
111<DD><A ID="idl:ismoothing:map2_out"></A> required output: output smoothed map, can be a FITS file, or a memory array
112  </DL>
113
114<P>
115<hr><H1>KEYWORDS</H1>
116
117  <DL COMPACT><DT>
118<B>beam_file=</B>
119<DD><A ID="idl:ismoothing:beam_file"></A> beam window function, either a FITS file or an array
120		(see <A HREF="./fac_Using_HEALPix_Fortran_90_fa.htm#fac:subsec:beamfiles">&rdquo;Beam window function files&rdquo;</A> section
121		in the <A ID="tex2html46"
122  HREF="facilities.htm"><b>HEALPix</b> Fortran Facilities document</A>).
123
124<P>
125<DT>
126<B>binpath=</B>
127<DD><A ID="idl:ismoothing:binpath"></A> full path to back-end routine <b>default:</b>$HEXE/smoothing, then $HEALPIX/bin/smoothing
128<BR>              - a binpath starting with / (or <SPAN CLASS="MATH"><IMG STYLE="height: 2.33ex; vertical-align: -0.68ex; " SRC="idl_img74.png"
129 ALT="$\backslash$"></SPAN>), <SPAN CLASS="MATH">&nbsp;</SPAN> or $ is interpreted as absolute
130<BR>              - a binpath starting with ./ is interpreted as relative to current directory
131<BR>              - all other binpaths are relative to $HEALPIX
132
133<P>
134<DT>
135<B>/double</B>
136<DD><A ID="idl:ismoothing:double"></A> if set, I/O is done in double precision <b>default:</b>single precision I/O
137
138<P>
139<DT>
140<B>fwhm_arcmin=</B>
141<DD><A ID="idl:ismoothing:fwhm_arcmin"></A> gaussian beam Full Width Half Maximum in arc-minutes <b>default:</b>0
142
143<P>
144<DT>
145<B>/help</B>
146<DD><A ID="idl:ismoothing:help"></A> if set, prints extended help
147
148<P>
149<DT>
150<B>iter_order=</B>
151<DD><A ID="idl:ismoothing:iter_order"></A> order of iteration in the analysis <b>default:</b>0
152
153<P>
154<DT>
155<B>/keep_tmp_files</B>
156<DD><A ID="idl:ismoothing:keep_tmp_files"></A> if set, temporary files are not discarded at the end of the
157                  run
158
159<P>
160<DT>
161<B>lmax=, nlmax=</B>
162<DD><A ID="idl:ismoothing:lmax"></A> maximum multipole of smoothing <b>default:</b>determined by back-end routine (ie, smoothing)
163
164<P>
165<DT>
166<B>/nested</B>
167<DD><A ID="idl:ismoothing:nested"></A> if set, signals that *all* maps and mask read online are in
168   NESTED scheme (does not apply to FITS file),
169<A HREF="#idl:ismoothing:ring"><TT>/ring</TT></A> and
170<A HREF="#idl:ismoothing:ordering"><TT>Ordering</TT></A>
171
172<P>
173<DT>
174<B>ordering=</B>
175<DD><A ID="idl:ismoothing:ordering"></A> either 'RING' or 'NESTED', ordering of online maps and masks,
176see
177<A HREF="#idl:ismoothing:ring"><TT>/ring</TT></A> and
178<A HREF="#idl:ismoothing:nested"><TT>/nested</TT></A>
179
180<P>
181<DT>
182<B>plmfile=</B>
183<DD><A ID="idl:ismoothing:plmfile"></A> FITS file containing precomputed Spherical Harmonics (deprecated) <b>default:</b>no file
184
185<P>
186<DT>
187<B>regression=</B>
188<DD><A ID="idl:ismoothing:regression"></A> 0, 1 or 2, regress out best fit monopole and/or dipole before
189    alm analysis
190  <b>default:</b>0, analyze raw map
191
192<P>
193<DT>
194<B>/ring</B>
195<DD><A ID="idl:ismoothing:ring"></A> see
196<A HREF="#idl:ismoothing:nested"><TT>/nested</TT></A> and
197<A HREF="#idl:ismoothing:ordering"><TT>Ordering</TT></A> above
198
199<P>
200<DT>
201<B>simul_type=</B>
202<DD><A ID="idl:ismoothing:simul_type"></A> 1 or 2, analyze temperature only or temperature + polarization
203
204<P>
205<DT>
206<B>/silent</B>
207<DD><A ID="idl:ismoothing:silent"></A> if set, works silently
208
209<P>
210<DT>
211<B>theta_cut_deg=</B>
212<DD><A ID="idl:ismoothing:theta_cut_deg"></A> cut around the equatorial plane
213
214<P>
215<DT>
216<B>tmpdir=</B>
217<DD><A ID="idl:ismoothing:tmpdir"></A> directory in which are written temporary files
218<b>default:</b>IDL_TMPDIR (see IDL documentation)
219
220<P>
221<DT>
222<B>won=</B>
223<DD><A ID="idl:ismoothing:won"></A>
224if set to 0, no weighting applied, if set to 1, a ring-based quadrature weighting scheme is applied,
225              if set to 2, a pixel-based quadrature weighting scheme is applied.
226    <b>default:</b>1: apply ring-based weighting
227
228<P>
229<DT>
230<B>w8file=</B>
231<DD><A ID="idl:ismoothing:w8file"></A> FITS file containing weights
232     <b>default:</b>determined automatically by back-end routine.
233   Do not set this keyword unless you really know what you are doing
234
235<P>
236<DT>
237<B>w8dir=</B>
238<DD><A ID="idl:ismoothing:w8dir"></A> directory where the weights are to be found
239        <b>default:</b>determined automatically by back-end routine
240
241<P>
242</DL>
243
244<P>
245<hr>
246<H1>DESCRIPTION</H1>
247<blockquote>
248<FONT COLOR="#CC0000">ismoothing</FONT> is an interface to '<A HREF="./fac_smoothing.htm#fac:smoothing">smoothing</A>' F90 facility. It
249requires some disk space on which to write the parameter file and the other
250temporary files. Most data can be provided/generated as an external FITS
251file, or as a memory array.
252</blockquote>
253
254<P>
255<hr><H1>RELATED ROUTINES</H1><h3>This section lists the routines related to <b><FONT COLOR="#CC0000">ismoothing</FONT></b></h3>
256
257  <DL COMPACT><DT>
258<B>idl</B>
259<DD>version 6.4 or more is necessary to run <FONT COLOR="#CC0000">ismoothing</FONT>.
260    <DT>
261<B>smoothing</B>
262<DD>F90 facility called by <FONT COLOR="#CC0000">ismoothing</FONT>.
263    <DT>
264<B><A HREF="idl_beam2bl.htm#idl:beam2bl">beam2bl</A></B>
265<DD>This IDL facility computes a transfer
266(or window) function <SPAN CLASS="MATH"><I>b</I>(<I>l</I>)</SPAN> (such as the ones required by <FONT COLOR="#CC0000">ismoothing</FONT>) for a given
267circular beam profile <SPAN CLASS="MATH"><IMG STYLE="height: 2.33ex; vertical-align: -0.68ex; " SRC="idl_img36.png"
268 ALT="$b(\theta)$"></SPAN>
269    <DT>
270<B><A HREF="idl_ialteralm.htm#idl:ialteralm">ialteralm</A></B>
271<DD>IDL Interface to F90 <A HREF="./fac_alteralm.htm#fac:alteralm">alteralm</A>
272    <DT>
273<B><A HREF="idl_ianafast.htm#idl:ianafast">ianafast</A></B>
274<DD>IDL Interface to F90 <A HREF="./fac_anafast.htm#fac:anafast">anafast</A> and C++ anafast_cxx
275    <DT>
276<B><A HREF="idl_iprocess_mask.htm#idl:iprocess_mask">iprocess_mask</A></B>
277<DD>IDL Interface to F90 <A HREF="./fac_process_mask.htm#fac:process_mask">process_mask</A>
278<DT>
279<B><A HREF="idl_isynfast.htm#idl:isynfast">isynfast</A></B>
280<DD>IDL Interface to F90 <A HREF="./fac_synfast.htm#fac:synfast">synfast</A>
281  </DL>
282
283<P>
284<HR><H1>EXAMPLE:</H1>
285<tt><TABLE CELLPADDING=3>
286<TR><TD ALIGN="LEFT">whitenoise = randomn(seed, <A HREF="idl_nside2npix.htm#idl:nside2npix">nside2npix</A>(256))</TD>
287</TR>
288<TR><TD ALIGN="LEFT"><FONT COLOR="#CC0000">ismoothing</FONT>, whitenoise, rednoise, fwhm=120, /ring, simul=1,/silent</TD>
289</TR>
290<TR><TD ALIGN="LEFT"><A HREF="idl_mollview.htm#idl:mollview">mollview</A>, whitenoise,title='White noise'</TD>
291</TR>
292<TR><TD ALIGN="LEFT"><A HREF="idl_mollview.htm#idl:mollview">mollview</A>, rednoise,  title='Smoothed white Noise'</TD>
293</TR>
294</TABLE></tt>
295<blockquote>
296will generate and plot a white noise map and its smoothed version
297</blockquote>
298
299<P>
300
301<P>
302
303<P>
304
305<DIV CLASS="navigation"><HR>
306<!--Navigation Panel-->
307<A
308 HREF="idl_iprocess_mask.htm">
309<IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A>
310<A
311 HREF="idl_HEALPix_IDL_subroutines.htm">
312<IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A>
313<A
314 HREF="idl_isynfast.htm">
315<IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A>
316<A ID="tex2html353"
317  HREF="idl_TABLE_CONTENTS.htm">
318<IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A>
319<BR>
320<B> Previous:</B> <A
321 HREF="idl_iprocess_mask.htm">iprocess_mask</A>
322
323<B>Up:</B> <A
324 HREF="idl_HEALPix_IDL_subroutines.htm">HEALPix/IDL subroutines</A>
325
326<B> Next:</B> <A
327 HREF="idl_isynfast.htm">isynfast</A>
328<B> Top:</B> <a href="main.htm">Main Page</a></DIV>
329<!--End of Navigation Panel-->
330<ADDRESS>
331Version 3.50, 2018-12-10
332</ADDRESS>
333</BODY>
334</HTML>
335