models.model.SyntheticModel

class SyntheticModel(base_dir='')

Bases: object

This is a class to load individual kosmatau3d models. This is merely for the convenience of examining the model information in a consistent manner. There is an optional argument when initialising to set a base directory, which makes it easier to load multiple models in succession. Due to the complexity of the kosmatau3d models, it is not recommended to load multiple models at the same time.

This initialises the object along with the base directory. The owned objects of base_dir and files are created. files can be modified again when loading a model, but for now it has the default filenames created with kosmatau3d.

Parameters:

base_dir – the base directory to use when loading models. Default: “”.

Methods

change_files	Change the specified filenames.
close_files	Close any open FITS files.
get_abundances	Return species abundance data.
get_dust_intensity	Return dust intensity in synthetic observation.
get_dust_optical_depth	Return dust optical depth in synthetic observation.
get_dust_temperature	Return dust temperature data.
get_dust_wavelengths	Return dust wavelengths used in model.
get_gas_temperature	Return gas temperature data.
get_hi_intensity	Return HI 21cm line intensity in synthetic observation.
get_hi_optical_depth	Return HI 21cm line optical depth in synthetic observation.
get_model_dust_absorption	Return dust absorption in model (ie.
get_model_dust_emissivity	Return dust emissivity in model (ie.
get_model_dust_intensity	Return dust intensity in model (ie.
get_model_hi_absorption	Return HI 21cm line absorption in model (ie.
get_model_hi_emissivity	Return HI 21cm line emissivity in model (ie.
get_model_hi_intensity	Return HI 21cm line emissivity in model (ie.
get_model_species_absorption	Return species absorption in model (ie.
get_model_species_emissivity	Return species emissivity in model (ie.
get_model_species_intensity	Return species intensity in model (ie.
get_species_intensity	Return species intensity in synthetic observation.
get_species_number	Return species number data.
get_species_optical_depth	Return species optical depth in synthetic observation.
get_volume_filling_factor	Return volume filling factor data.
load_model
plot_model_quantity	Return a 3DAxes with the specitied quantity shown in the colour scale.
radial_plot	Plot a given quantity as a function of galactocentric radius.

change_files(**kwargs)

Change the specified filenames.

close_files(**kwargs)

Close any open FITS files.

get_abundances(*args, **kwargs)

Return species abundance data.

get_dust_intensity(wavelength=None, idx=None)

Return dust intensity in synthetic observation.

get_dust_optical_depth(wavelength=None, idx=None)

Return dust optical depth in synthetic observation.

get_dust_temperature(total=True)

Return dust temperature data.

get_dust_wavelengths()

Return dust wavelengths used in model.

get_gas_temperature(total=True)

Return gas temperature data.

get_hi_intensity(include_dust=False, integrated=False)

Return HI 21cm line intensity in synthetic observation.

get_hi_optical_depth(include_dust=False)

Return HI 21cm line optical depth in synthetic observation.

get_model_dust_absorption(wavelength=None, idx=None)

Return dust absorption in model (ie. for each voxel).

get_model_dust_emissivity(wavelength=None, idx=None)

Return dust emissivity in model (ie. for each voxel).

get_model_dust_intensity(wavelength=None, idx=None)

Return dust intensity in model (ie. for each voxel).

get_model_hi_absorption(include_dust=False)

Return HI 21cm line absorption in model (ie. for each voxel).

get_model_hi_emissivity(include_dust=False)

Return HI 21cm line emissivity in model (ie. for each voxel).

get_model_hi_intensity(include_dust=False, integrated=False)

Return HI 21cm line emissivity in model (ie. for each voxel).

get_model_species_absorption(transition=None, idx=None, include_dust=False)

Return species absorption in model (ie. for each voxel).

get_model_species_emissivity(transition=None, idx=None, include_dust=False)

Return species emissivity in model (ie. for each voxel).

get_model_species_intensity(transition=None, idx=None, include_dust=False, integrated=False)

Return species intensity in model (ie. for each voxel).

get_species_intensity(transition=None, idx=None, include_dust=False, integrated=False)

Return species intensity in synthetic observation.

get_species_number(species=None, abun=False, nref=[('H', 1), ('H2', 2)], total=True)

Return species number data. This is the number of a given species contained in each voxel.

get_species_optical_depth(transition=None, idx=None, include_dust=False)

Return species optical depth in synthetic observation.

get_volume_filling_factor()

Return volume filling factor data.

plot_model_quantity(quantity=None, transition=None, transition2=None, ens=None, log=False, stat='max', include_dust=False, integrated=False, vmin=None, vmax=None, cmap_kwargs={'alpha': 0.8, 'cmap': 'magma', 'marker': 's', 's': 27}, cbar_kwargs={}, label_axes=False, verbose=False, **kwargs)

Return a 3DAxes with the specitied quantity shown in the colour scale.

radial_plot(quantity='intensity', transition=['CO 1'], transition2=[], idx=0, lat=0, include_dust=False, integrated=False, log=False, scale=False, normalized=False, ls='-', lw=2, color='xkcd:maroon', label='', fontsize=42, labelsize=36, legendsize=36, legendloc=0, bins=36, bin_lim=(0, 18000), stat='mean', voxel_size=None, ax=None)

Plot a given quantity as a function of galactocentric radius. This is only valid for galaxy models of type ‘disk’.