hyperion.conf.BinnedImageConf¶
-
class
hyperion.conf.
BinnedImageConf
(n_theta=None, n_phi=None, **kwargs)¶ Method
set_aperture_radii
(self, n_ap, ap_min, ap_max)Set the range of apertures to use for SEDs/Images
set_image_limits
(self, xmin, xmax, ymin, ymax)Set the extent of the output images
set_image_size
(self, n_x, n_y)Set the size of the output images
set_output_bytes
(self, io_bytes)Set whether to output images/SEDs in 32-bit or 64-bit.
set_stokes
(self, stokes)Set whether to save the full Stokes vector for the images/SEDs.
set_track_origin
(self, track_origin[, n_scat])Set whether to track the origin of the photons.
set_uncertainties
(self, uncertainties)Set whether to compute uncertainties on the images/SEDs
set_viewing_bins
(self, n_theta, n_phi)Set the number of viewing angles to use
set_wavelength_range
(self, n_wav, wav_min, …)Set the range of wavelengths to use for SEDs/Images
Methods (detail)
-
set_aperture_radii
(self, n_ap, ap_min, ap_max)¶ Set the range of apertures to use for SEDs/Images
- Parameters
- n_apint
The number of apertures to compute SEDs in
- ap_min, ap_maxfloat
The smallest and largest aperture to use, in cm
-
set_image_limits
(self, xmin, xmax, ymin, ymax)¶ Set the extent of the output images
- Parameters
- xmin, xmax, ymin, ymaxfloat
The extent of the images, which are either in cm (if using standard binned images or peeloff images) or in degrees (if using peeling off to a point inside the model).
-
set_image_size
(self, n_x, n_y)¶ Set the size of the output images
- Parameters
- n_x, n_yint
The number of pixels in the x and y directions
-
set_output_bytes
(self, io_bytes)¶ Set whether to output images/SEDs in 32-bit or 64-bit.
- Parameters
- io_bytesint
The number of bytes for the output. This should be either 4 (for 32-bit) or 8 (for 64-bit).
-
set_stokes
(self, stokes)¶ Set whether to save the full Stokes vector for the images/SEDs.
If set to False, only the I component is saved.
- Parameters
- stokesbool
Whether to save the full Stokes vector for the images/SEDs.
-
set_track_origin
(self, track_origin, n_scat=None)¶ Set whether to track the origin of the photons. The options are:
‘no’ - does not split up the images/SEDs by origin
‘basic’ - this splits up the images/SEDs into:
The photons last emitted from a source and did not undergo any subsequent interactions.
The photons last emitted from dust and did not undergo any subsequent interactions
The photons last emitted from a source and subsequently scattered
The photons last emitted from dust and subsequently scattered
- ‘detailed’ - as above, but in each category, the origin is further
refined into each individual source and dust type.
- ‘scatterings’ - as for ‘basic’, but splitting the scatterings into the
images for 1, 2, 3, …,
n_scat
scatterings since the last emission.
- Parameters
- track_originbool
Whether to track the origin of the photons as described above.
-
set_uncertainties
(self, uncertainties)¶ Set whether to compute uncertainties on the images/SEDs
- Parameters
- uncertaintiesbool
Whether to compute uncertainties on the images/SEDs.
-
set_viewing_bins
(self, n_theta, n_phi)¶ Set the number of viewing angles to use
- Parameters
- n_theta, n_phi
The number of viewing angles to use in the theta and phi directions respectively.
-
set_wavelength_index_range
(self, iwav_min, iwav_max)¶ Set the range of wavelengths to use for SEDs/Images
This is intended to be used when the monochromatic option is turned on.
- Parameters
- iwav_min, iwav_maxint
The index of the first and last frequency to compute SEDs/Images for. This is the index in the array of wavelengths used when calling
set_monochromatic
. These values should be zero-based.
-
set_wavelength_range
(self, n_wav, wav_min, wav_max)¶ Set the range of wavelengths to use for SEDs/Images
- Parameters
- n_wavint
The number of wavelengths to compute SEDs/Images for
- wav_min, wav_maxfloat
The smallest and largest wavelength to use, in microns
-