Deploying to gh-pages from @ 0c3f1c1 🚀

cta-observatory · Nov 7, 2024 · 6ea2d9f · 6ea2d9f
1 parent 5298404
commit 6ea2d9f
Show file tree

Hide file tree

Showing 30 changed files with 1,184 additions and 94 deletions.
diff --git a/_modules/pyirf/irf/effective_area.html b/_modules/pyirf/irf/effective_area.html
@@ -103,6 +103,8 @@ <h1>Source code for pyirf.irf.effective_area</h1><div class="highlight"><pre>
     <span class="s2">&quot;effective_area&quot;</span><span class="p">,</span>
     <span class="s2">&quot;effective_area_per_energy&quot;</span><span class="p">,</span>
     <span class="s2">&quot;effective_area_per_energy_and_fov&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;effective_area_3d_polar&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;effective_area_3d_lonlat&quot;</span><span class="p">,</span>
 <span class="p">]</span>
 
 
@@ -190,6 +192,113 @@ <h1>Source code for pyirf.irf.effective_area</h1><div class="highlight"><pre>
 
     <span class="k">return</span> <span class="n">effective_area</span><span class="p">(</span><span class="n">hist_selected</span><span class="p">,</span> <span class="n">hist_simulated</span><span class="p">,</span> <span class="n">area</span><span class="p">)</span></div>
 
+
+
+<div class="viewcode-block" id="effective_area_3d_polar">
+<a class="viewcode-back" href="../../../api/pyirf.irf.effective_area_3d_polar.html#pyirf.irf.effective_area_3d_polar">[docs]</a>
+<span class="k">def</span> <span class="nf">effective_area_3d_polar</span><span class="p">(</span>
+    <span class="n">selected_events</span><span class="p">,</span>
+    <span class="n">simulation_info</span><span class="p">,</span>
+    <span class="n">true_energy_bins</span><span class="p">,</span>
+    <span class="n">fov_offset_bins</span><span class="p">,</span>
+    <span class="n">fov_position_angle_bins</span><span class="p">,</span>
+<span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Calculate effective area in bins of true energy, field of view offset, and field of view position angle.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    selected_events: astropy.table.QTable</span>
+<span class="sd">        DL2 events table, required columns for this function:</span>
+<span class="sd">        - `true_energy`</span>
+<span class="sd">        - `true_source_fov_offset`</span>
+<span class="sd">        - `true_source_fov_position_angle`</span>
+<span class="sd">    simulation_info: pyirf.simulations.SimulatedEventsInfo</span>
+<span class="sd">        The overall statistics of the simulated events</span>
+<span class="sd">    true_energy_bins: astropy.units.Quantity[energy]</span>
+<span class="sd">        The true energy bin edges in which to calculate effective area.</span>
+<span class="sd">    fov_offset_bins: astropy.units.Quantity[angle]</span>
+<span class="sd">        The field of view radial bin edges in which to calculate effective area.</span>
+<span class="sd">    fov_position_angle_bins: astropy.units.Quantity[radian]</span>
+<span class="sd">        The field of view azimuthal bin edges in which to calculate effective area.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">area</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> <span class="n">simulation_info</span><span class="o">.</span><span class="n">max_impact</span><span class="o">**</span><span class="mi">2</span>
+
+    <span class="n">hist_simulated</span> <span class="o">=</span> <span class="n">simulation_info</span><span class="o">.</span><span class="n">calculate_n_showers_3d_polar</span><span class="p">(</span>
+        <span class="n">true_energy_bins</span><span class="p">,</span> <span class="n">fov_offset_bins</span><span class="p">,</span> <span class="n">fov_position_angle_bins</span>
+    <span class="p">)</span>
+
+    <span class="n">hist_selected</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">histogramdd</span><span class="p">(</span>
+        <span class="n">np</span><span class="o">.</span><span class="n">column_stack</span><span class="p">(</span>
+            <span class="p">[</span>
+                <span class="n">selected_events</span><span class="p">[</span><span class="s2">&quot;true_energy&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">TeV</span><span class="p">),</span>
+                <span class="n">selected_events</span><span class="p">[</span><span class="s2">&quot;true_source_fov_offset&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">deg</span><span class="p">),</span>
+                <span class="n">selected_events</span><span class="p">[</span><span class="s2">&quot;true_source_fov_position_angle&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">rad</span><span class="p">),</span>
+            <span class="p">]</span>
+        <span class="p">),</span>
+        <span class="n">bins</span><span class="o">=</span><span class="p">(</span>
+            <span class="n">true_energy_bins</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">TeV</span><span class="p">),</span>
+            <span class="n">fov_offset_bins</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">deg</span><span class="p">),</span>
+            <span class="n">fov_position_angle_bins</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">rad</span><span class="p">),</span>
+        <span class="p">),</span>
+    <span class="p">)</span>
+
+    <span class="k">return</span> <span class="n">effective_area</span><span class="p">(</span><span class="n">hist_selected</span><span class="p">,</span> <span class="n">hist_simulated</span><span class="p">,</span> <span class="n">area</span><span class="p">)</span></div>
+
+
+
+<div class="viewcode-block" id="effective_area_3d_lonlat">
+<a class="viewcode-back" href="../../../api/pyirf.irf.effective_area_3d_lonlat.html#pyirf.irf.effective_area_3d_lonlat">[docs]</a>
+<span class="k">def</span> <span class="nf">effective_area_3d_lonlat</span><span class="p">(</span>
+    <span class="n">selected_events</span><span class="p">,</span>
+    <span class="n">simulation_info</span><span class="p">,</span>
+    <span class="n">true_energy_bins</span><span class="p">,</span>
+    <span class="n">fov_longitude_bins</span><span class="p">,</span>
+    <span class="n">fov_latitude_bins</span><span class="p">,</span>
+    <span class="n">subpixels</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span>
+<span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Calculate effective area in bins of true energy, field of view longitude, and field of view latitude.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    selected_events: astropy.table.QTable</span>
+<span class="sd">        DL2 events table, required columns for this function:</span>
+<span class="sd">        - `true_energy`</span>
+<span class="sd">        - `true_source_fov_lon`</span>
+<span class="sd">        - `true_source_fov_lat`</span>
+<span class="sd">    simulation_info: pyirf.simulations.SimulatedEventsInfo</span>
+<span class="sd">        The overall statistics of the simulated events</span>
+<span class="sd">    true_energy_bins: astropy.units.Quantity[energy]</span>
+<span class="sd">        The true energy bin edges in which to calculate effective area.</span>
+<span class="sd">    fov_longitude_bins: astropy.units.Quantity[angle]</span>
+<span class="sd">        The field of view longitude bin edges in which to calculate effective area.</span>
+<span class="sd">    fov_latitude_bins: astropy.units.Quantity[angle]</span>
+<span class="sd">        The field of view latitude bin edges in which to calculate effective area.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">area</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> <span class="n">simulation_info</span><span class="o">.</span><span class="n">max_impact</span><span class="o">**</span><span class="mi">2</span>
+
+    <span class="n">hist_simulated</span> <span class="o">=</span> <span class="n">simulation_info</span><span class="o">.</span><span class="n">calculate_n_showers_3d_lonlat</span><span class="p">(</span>
+        <span class="n">true_energy_bins</span><span class="p">,</span> <span class="n">fov_longitude_bins</span><span class="p">,</span> <span class="n">fov_latitude_bins</span><span class="p">,</span> <span class="n">subpixels</span><span class="o">=</span><span class="n">subpixels</span>
+    <span class="p">)</span>
+
+    <span class="n">selected_columns</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">column_stack</span><span class="p">(</span>
+            <span class="p">[</span>
+                <span class="n">selected_events</span><span class="p">[</span><span class="s2">&quot;true_energy&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">TeV</span><span class="p">),</span>
+                <span class="n">selected_events</span><span class="p">[</span><span class="s2">&quot;true_source_fov_lon&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">deg</span><span class="p">),</span>
+                <span class="n">selected_events</span><span class="p">[</span><span class="s2">&quot;true_source_fov_lat&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">deg</span><span class="p">),</span>
+            <span class="p">]</span>
+        <span class="p">)</span>
+    <span class="n">bins</span> <span class="o">=</span> <span class="p">(</span>
+            <span class="n">true_energy_bins</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">TeV</span><span class="p">),</span>
+            <span class="n">fov_longitude_bins</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">deg</span><span class="p">),</span>
+            <span class="n">fov_latitude_bins</span><span class="o">.</span><span class="n">to_value</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">deg</span><span class="p">),</span>
+    <span class="p">)</span>
+
+    <span class="n">hist_selected</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">histogramdd</span><span class="p">(</span><span class="n">selected_columns</span><span class="p">,</span> <span class="n">bins</span><span class="o">=</span><span class="n">bins</span><span class="p">)</span>
+
+    <span class="k">return</span> <span class="n">effective_area</span><span class="p">(</span><span class="n">hist_selected</span><span class="p">,</span> <span class="n">hist_simulated</span><span class="p">,</span> <span class="n">area</span><span class="p">)</span></div>
+
 </pre></div>
 
            </div>