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>add_dipole*</TITLE> 7<META NAME="description" CONTENT="add_dipole*"> 8<META NAME="keywords" CONTENT="subroutines"> 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="subroutines.css"> 27 28<LINK REL="next" HREF="sub_alm2cl.htm"> 29<LINK REL="previous" HREF="sub_add_card.htm"> 30<LINK REL="next" HREF="sub_alm2cl.htm"> 31</HEAD> 32 33<body text="#000000" bgcolor="#FFFFFA"> 34 35<DIV CLASS="navigation"><!--Navigation Panel--> 36<A 37 HREF="sub_add_card.htm"> 38<IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A> 39<A 40 HREF="sub_HEALPix_F90_subroutines.htm"> 41<IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A> 42<A 43 HREF="sub_alm2cl.htm"> 44<IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A> 45<A ID="tex2html304" 46 HREF="sub_TABLE_CONTENTS.htm"> 47<IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A> 48<BR> 49<B> Previous:</B> <A 50 HREF="sub_add_card.htm">add_card</A> 51 52<B>Up:</B> <A 53 HREF="sub_HEALPix_F90_subroutines.htm">HEALPix/F90 subroutines</A> 54 55<B> Next:</B> <A 56 HREF="sub_alm2cl.htm">alm2cl*</A> 57<B> Top:</B> <a href="main.htm">Main Page</a></DIV> 58<!--End of Navigation Panel--> 59 60<H1><A ID="SECTION600"></A> 61<A ID="sub:add_dipole"></A> 62<BR> 63 64</H1> 65 66<P> 67<b><font size=+6><FONT COLOR="#CC0000">add_dipole*</FONT></font></b><hr> 68<H3>This routine provides a means to add a monopole and dipole to a <b>HEALPix</b> map.</H3> 69Location in HEALPix directory tree: <a href="https://sourceforge.net/p/healpix/code/1005/tree/trunk/src/f90/mod/pix_tools.F90"><b>src/f90/mod/pix_tools.F90</b></a> 70 71<P> 72<hr><h1>FORMAT </h1><blockquote><h3>call <FONT COLOR="#CC0000">add_dipole*</FONT>( 73<A HREF="#sub:add_dipole:nside">nside</A>, <A HREF="#sub:add_dipole:map">map</A>, <A HREF="#sub:add_dipole:ordering">ordering</A>, <A HREF="#sub:add_dipole:degree">degree</A>, <A HREF="#sub:add_dipole:multipoles">multipoles</A><i><font color="#224422">[, <A HREF="#sub:add_dipole:fmissval">fmissval</A>]</font></i> 74)</h3></blockquote> 75Arguments appearing in <i><font color="#224422">italic</font></i> are 76optional. 77 78<P> 79<hr><H1>ARGUMENTS</H1> 80 81<TABLE CELLPADDING=3 BORDER="1"> 82<TR><TH ALIGN="LEFT" VALIGN="TOP" WIDTH=160><SPAN CLASS="textbf">name & dimensionality</SPAN></TH> 83<TH ALIGN="LEFT" VALIGN="TOP" WIDTH=25><SPAN CLASS="textbf">kind</SPAN></TH> 84<TH ALIGN="LEFT" VALIGN="TOP" WIDTH=40><SPAN CLASS="textbf">in/out</SPAN></TH> 85<TH ALIGN="LEFT" VALIGN="TOP" WIDTH=225><SPAN CLASS="textbf">description</SPAN></TH> 86</TR> 87<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160> </TD> 88<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25> </TD> 89<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40> </TD> 90<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225> </TD> 91</TR> 92<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160> 93nside<A ID="sub:add_dipole:nside"></A></TD> 94<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25>I4B</TD> 95<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40>IN</TD> 96<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225>value of <!-- MATH 97 $N_{\mathrm{side}}$ 98 --> 99<SPAN CLASS="MATH"><I>N</I><SUB>side</SUB></SPAN> resolution parameter for input map</TD> 100</TR> 101<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160>map<A ID="sub:add_dipole:map"></A>(0:12*nside*nside-1)</TD> 102<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25>SP/ DP</TD> 103<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40>INOUT</TD> 104<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225><b>HEALPix</b> map to which the monopole and dipole will be 105 added. Those are added to <EM>all unflagged pixels</EM>.</TD> 106</TR> 107<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160>ordering<A ID="sub:add_dipole:ordering"></A></TD> 108<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25>I4B</TD> 109<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40>IN</TD> 110<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225><b>HEALPix</b> scheme 1:RING, 2: NESTED</TD> 111</TR> 112<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160>degree<A ID="sub:add_dipole:degree"></A></TD> 113<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25>I4B</TD> 114<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40>IN</TD> 115<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225>multipoles to add. It is either 0 (nothing done), 116 1 (monopole only) or 2 (monopole and dipole)</TD> 117</TR> 118<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160>multipoles<A ID="sub:add_dipole:multipoles"></A>(0:degree*degree-1)</TD> 119<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25>DP</TD> 120<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40>IN</TD> 121<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225>values of monopole and 122 dipole to add. The monopole is described as a scalar in the same 123 units as the input map, the dipole as a 3D cartesian vector, 124 in the same units.</TD> 125</TR> 126<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=160><i><font color="#224422">fmissval<A ID="sub:add_dipole:fmissval"></A></font></i></TD> 127<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=25>SP/ DP</TD> 128<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=40>IN</TD> 129<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=225>value used to flag bad pixel on input 130 <b>default:</b>-1.6375e30. Pixels with that value are left unchanged.</TD> 131</TR> 132</TABLE> 133 134<HR><H1>EXAMPLE:</H1> 135<tt>call <FONT COLOR="#CC0000">add_dipole*</FONT>(128, map, 1, 2, (<SPAN CLASS="MATH"><IMG STYLE="height: 2.33ex; vertical-align: -0.68ex; " SRC="sub_img17.png" 136 ALT="$\backslash$"></SPAN> 10.0_dp, 0.0_dp, 1.2_dp,0.0_dp <SPAN CLASS="MATH"><IMG STYLE="height: 2.33ex; vertical-align: -0.68ex; " SRC="sub_img17.png" 137 ALT="$\backslash$"></SPAN>) ) 138<BR></tt> 139<blockquote> 140<TT>map</TT> is a <b>HEALPix</b> map of resolution <!-- MATH 141 $N_{\mathrm{side}}=128$ 142 --> 143<SPAN CLASS="MATH"><I>N</I><SUB>side</SUB>=128</SPAN>, with the RING ordering scheme. A 144monopole of amplitude 10 and a dipole of amplitude 1.2 and directed along the 145<SPAN CLASS="MATH"><I>y</I></SPAN> axis will be added to it. 146</blockquote> 147 148<P> 149<hr><H1>MODULES & ROUTINES</H1><H3>This section lists the modules and routines used by <FONT COLOR="#CC0000">add_dipole*</FONT>.</h3> 150 <DL COMPACT><DT> 151<B><SPAN CLASS="textbf">pix_tools</SPAN></B> 152<DD>module, containing: 153</DL> 154 155<P> 156<hr><H1>RELATED ROUTINES</H1><h3>This section lists the routines related to <b><FONT COLOR="#CC0000">add_dipole*</FONT></b></h3> 157 158 <DL COMPACT><DT> 159<B><A HREF="sub_remove_dipole.htm#sub:remove_dipole">remove_dipole</A></B> 160<DD>routine to remove the best fit monopole and 161 monopole from a map. 162 </DL> 163 164<P> 165 166<P> 167 168 169<P> 170 171<P> 172 173<DIV CLASS="navigation"><HR> 174<!--Navigation Panel--> 175<A 176 HREF="sub_add_card.htm"> 177<IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A> 178<A 179 HREF="sub_HEALPix_F90_subroutines.htm"> 180<IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A> 181<A 182 HREF="sub_alm2cl.htm"> 183<IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A> 184<A ID="tex2html304" 185 HREF="sub_TABLE_CONTENTS.htm"> 186<IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A> 187<BR> 188<B> Previous:</B> <A 189 HREF="sub_add_card.htm">add_card</A> 190 191<B>Up:</B> <A 192 HREF="sub_HEALPix_F90_subroutines.htm">HEALPix/F90 subroutines</A> 193 194<B> Next:</B> <A 195 HREF="sub_alm2cl.htm">alm2cl*</A> 196<B> Top:</B> <a href="main.htm">Main Page</a></DIV> 197<!--End of Navigation Panel--> 198<ADDRESS> 199Version 3.50, 2018-12-10 200</ADDRESS> 201</BODY> 202</HTML> 203
