diff options
Diffstat (limited to 'fg21sim/galactic/freefree.py')
| -rw-r--r-- | fg21sim/galactic/freefree.py | 36 |
1 files changed, 31 insertions, 5 deletions
diff --git a/fg21sim/galactic/freefree.py b/fg21sim/galactic/freefree.py index f47f008..878a833 100644 --- a/fg21sim/galactic/freefree.py +++ b/fg21sim/galactic/freefree.py @@ -214,6 +214,11 @@ class FreeFree: def output(self, hpmap, frequency): """Write the simulated free-free map to disk with proper header keywords and history. + + Returns + ------- + filepath : str + The (absolute) path to the output HEALPix map file. """ if not os.path.exists(self.output_dir): os.mkdir(self.output_dir) @@ -233,6 +238,7 @@ class FreeFree: write_fits_healpix(filepath, hpmap, header=header, clobber=self.clobber, checksum=self.checksum) logger.info("Write simulated map to file: {0}".format(filepath)) + return filepath def preprocess(self): """Perform the preparation procedures for the final simulations. @@ -261,6 +267,14 @@ class FreeFree: References: [Dickinson2003], Eq.(11) NOTE: [Dickinson2003], Eq.(11) may wrongly have the "10^3" term. + + Returns + ------- + hpmap_f : 1D `~numpy.ndarray` + The HEALPix map (RING ordering) at the input frequency. + filepath : str + The (absolute) path to the output HEALPix file if saved, + otherwise ``None``. """ self.preprocess() # @@ -279,16 +293,28 @@ class FreeFree: hpmap_f = self.halphamap * ratio_K_R # if self.save: - self.output(hpmap_f, frequency) - return hpmap_f + filepath = self.output(hpmap_f, frequency) + else: + filepath = None + return (hpmap_f, filepath) def simulate(self, frequencies): - """Simulate the free-free map at every specified frequency.""" + """Simulate the synchrotron map at the specified frequencies. + + Returns + ------- + hpmaps : list[1D `~numpy.ndarray`] + List of HEALPix maps (in RING ordering) at each frequency. + paths : list[str] + List of (absolute) path to the output HEALPix maps. + """ hpmaps = [] + paths = [] for f in np.array(frequencies, ndmin=1): - hpmap_f = self.simulate_frequency(f) + hpmap_f, filepath = self.simulate_frequency(f) hpmaps.append(hpmap_f) - return hpmaps + paths.append(filepath) + return (hpmaps, paths) def postprocess(self): """Perform the post-simulation operations before the end.""" |