Data analysis functions

These functions are used internally and none are exported.

These functions depend on the particulars of the simulation code (e.g. units).

These functions read the data generated by the data acquisition functions, and produce the values that will be plotted.

Signature for the `plotSnapshot` function

A data analysis functions for plotSnapshot must take a dictionary with the following shape:

:sim_data -> ::Simulation (see Simulation).
:snap_data -> ::Snapshot (see Snapshot).
:gc_data -> ::GroupCatalog (see GroupCatalog).
cell/particle type -> (block -> data of block, block -> data of block, ...).
cell/particle type -> (block -> data of block, block -> data of block, ...).
cell/particle type -> (block -> data of block, block -> data of block, ...).
- ...
groupcat type -> (block -> data of block, block -> data of block, ...).
groupcat type -> (block -> data of block, block -> data of block, ...).
groupcat type -> (block -> data of block, block -> data of block, ...).
...

and return one or more vectors or matrices with the processed data. It should return nothing if the input data has some problem that prevents computation (e.g. is empty).

Expected signature:

  da_function(data_dict, args...; kwargs...) -> (processed_data, ...)

where:

data_dict::Dict
processed_data::Union{VecOrMat{<:Number},Nothing}

Signature for the `plotTimeSeries` function

A data analysis functions for plotTimeSeries must take a Simulation struct, and return two vectors. It should return nothing if the input data has some problem that prevents computation (e.g. is empty).

Expected signature:

  da_function(sim_data, args...; kw_args...) -> (processed_data_x, processed_data_y)

where:

sim_data::Simulation, see Simulation
processed_data_x::Vector{<:Number}
processed_data_y::Vector{<:Number}

GalaxyInspector.daBandProfile — Method

daBandProfile(
    data_dict::Dict,
    quantity::Symbol,
    grid::CircularGrid;
    <keyword arguments>
)::Union{
    Tuple{Vector{<:Unitful.Length},Vector{<:Number},Vector{<:Number},Vector{<:Number}},
    Tuple{Vector{<:Unitful.Length},Vector{<:Number},Vector{<:Number}},
    Nothing,
}

Compute the profile of a mean quantity with error bars or bands.

Arguments

data_dict::Dict: A dictionary with the following shape:
- :sim_data -> ::Simulation (see Simulation).
- :snap_data -> ::Snapshot (see Snapshot).
- :gc_data -> ::GroupCatalog (see GroupCatalog).
- cell/particle type -> (block -> data of block, block -> data of block, ...).
- cell/particle type -> (block -> data of block, block -> data of block, ...).
- cell/particle type -> (block -> data of block, block -> data of block, ...).
- ...
- groupcat type -> (block -> data of block, block -> data of block, ...).
- groupcat type -> (block -> data of block, block -> data of block, ...).
- groupcat type -> (block -> data of block, block -> data of block, ...).
- ...
quantity::Symbol: Target quantity. The possibilities are:
- :stellar_mass -> Stellar mass.
- :gas_mass -> Gas mass.
- :hydrogen_mass -> Hydrogen mass.
- :dm_mass -> Dark matter mass.
- :bh_mass -> Black hole mass.
- :molecular_mass -> Molecular hydrogen ($\mathrm{H_2}$) mass.
- :br_molecular_mass -> Molecular hydrogen ($\mathrm{H_2}$) mass, computed using the pressure relation in Blitz et al. (2006).
- :atomic_mass -> Atomic hydrogen ($\mathrm{HI}$) mass.
- :ionized_mass -> Ionized hydrogen ($\mathrm{HII}$) mass.
- :neutral_mass -> Neutral hydrogen ($\mathrm{HI + H_2}$) mass.
- :stellar_gas_mass -> Stellar gas mass (according to our SF model).
- :ode_metal_mass -> Metal mass (according to our SF model).
- :ode_metallicity -> Metallicity (according to our SF model).
- :dust_mass -> Dust mass.
- :molecular_fraction -> Gas mass fraction of molecular hydrogen.
- :br_molecular_fraction -> Gas mass fraction of molecular hydrogen, computed using the pressure relation in Blitz et al. (2006).
- :atomic_fraction -> Gas mass fraction of atomic hydrogen.
- :ionized_fraction -> Gas mass fraction of ionized hydrogen.
- :neutral_fraction -> Gas mass fraction of neutral hydrogen.
- :molecular_neutral_fraction -> Fraction of molecular hydrogen in the neutral gas.
- :ionized_neutral_fraction -> Fraction of ionized gas to neutral gas.
- :stellar_gas_fraction -> Stellar gas fraction (according to our SF model).
- :metal_gas_fraction -> Metallicity (according to our SF model).
- :dust_fraction -> Dust mass fraction.
- :gas_mass_density -> Gas mass density.
- :hydrogen_mass_density -> Hydrogen mass density.
- :gas_number_density -> Gas number density.
- :molecular_number_density -> Molecular hydrogen number density.
- :br_molecular_number_density -> Molecular hydrogen number density, computed using the pressure relation in Blitz et al. (2006).
- :atomic_number_density -> Atomic hydrogen number density.
- :ionized_number_density -> Ionized hydrogen number density.
- :neutral_number_density -> Neutral hydrogen number density.
- :gas_td -> Total gas depletion time.
- :molecular_td -> Molecular hydrogen ($\mathrm{H_2}$) depletion time.
- :br_molecular_td -> Molecular hydrogen ($\mathrm{H_2}$) depletion time, computed using the pressure relation in Blitz et al. (2006).
- :atomic_td -> Atomic hydrogen ($\mathrm{HI}$) depletion time.
- :ionized_td -> Ionized hydrogen ($\mathrm{HII}$) depletion time.
- :neutral_td -> Neutral hydrogen ($\mathrm{HI + H_2}$) depletion time.
- :gas_metallicity -> Mass fraction of all elements above He in the gas (solar units).
- :stellar_metallicity -> Mass fraction of all elements above He in the stars (solar units).
- :X_gas_abundance -> Gas abundance of element $\mathrm{X}$, as $12 + \log_{10}(\mathrm{X \, / \, H})$. The possibilities are the keys of ELEMENT_INDEX.
- :X_stellar_abundance -> Stellar abundance of element $\mathrm{X}$, as $12 + \log_{10}(\mathrm{X \, / \, H})$. The possibilities are the keys of ELEMENT_INDEX.
- :stellar_radial_distance -> Distance of every stellar particle to the origin.
- :gas_radial_distance -> Distance of every gas cell to the origin.
- :dm_radial_distance -> Distance of every dark matter particle to the origin.
- :stellar_xy_distance -> Projected distance of every stellar particle to the origin.
- :gas_xy_distance -> Projected distance of every gas cell to the origin.
- :dm_xy_distance -> Projected distance of every dark matter particle to the origin.
- :gas_sfr -> SFR associated to each gas particle/cell within the code.
- :stellar_circularity -> Stellar circularity.
- :stellar_vcirc -> Stellar circular velocity.
- :stellar_vradial -> Stellar radial speed.
- :stellar_vtangential -> Stellar tangential speed.
- :stellar_vzstar -> Stellar speed in the z direction, computed as $v_z \, \mathrm{sign}(z)$.
- :stellar_age -> Stellar age.
- :sfr -> Star formation rate.
- :ssfr -> The specific star formation rate.
- :observational_sfr -> Star formation rate of the last AGE_RESOLUTION.
- :observational_ssfr -> The specific star formation rate of the last AGE_RESOLUTION.
- :stellar_eff -> Star formation efficiency per free-fall time for the gas that has turn into stars.
- :gas_eff -> Star formation efficiency per free-fall time for the gas.
- :molecular_eff -> Star formation efficiency per free-fall time for the molecular hydrogen ($\mathrm{H_2}$) gas.
- :br_molecular_eff -> Star formation efficiency per free-fall time for the molecular hydrogen ($\mathrm{H_2}$) gas, computed using the pressure relation in Blitz et al. (2006).
- :atomic_eff -> Star formation efficiency per free-fall time for the atomic hydrogen ($\mathrm{HI}$) gas.
- :ionized_eff -> Star formation efficiency per free-fall time for the ionized hydrogen ($\mathrm{HII}$) gas.
- :neutral_eff -> Star formation efficiency per free-fall time for the neutral hydrogen ($\mathrm{HI + H_2}$) gas.
- :temperature -> Gas temperature, as $\log_{10}(T \, / \, \mathrm{K})$.
- :pressure -> Gas pressure.
- :ode_gas_it -> Integration time.
- :ode_gas_tau_s -> Star formation time scale, $\tau_\mathrm{S}$.
- :ode_gas_eta_d -> Photodissociation efficiency, $\eta_\mathrm{diss}$.
- :ode_gas_eta_i -> Photoionization efficiency, $\eta_\mathrm{ion}$.
- :ode_gas_r -> Mass recycling parameter, $R$.
- :ode_gas_cold_mf -> Cold gas mass fraction.
- :ode_stellar_it -> Integration time, for the gas that form the stars.
- :ode_stellar_tau_s -> Star formation time scale, $\tau_\mathrm{S}$, for the gas that form the stars.
- :ode_stellar_eta_d -> Photodissociation efficiency, $\eta_\mathrm{diss}$, for the gas that form the stars.
- :ode_stellar_eta_i -> Photoionization efficiency, $\eta_\mathrm{ion}$, for the gas that form the stars.
- :ode_stellar_r -> Mass recycling parameter, $R$, for the gas that form the stars.
- :ode_stellar_cold_mf -> Cold gas mass fraction, for the gas that form the stars.
- :ode_stellar_gas_rho -> Gas mass density, for the gas that form the stars.
- :ode_stellar_gas_Z -> Gas metallicity, for the gas that form the stars (solar units).
- :ode_stellar_gas_mass -> Cell mass, for the gas that form the stars.
- :ode_stellar_gas_sfr -> SFR associated to the gas particles/cells within the code, for the gas that form the stars.
- :ode_stellar_gas_P -> Gas pressure, for the gas that form the stars.
grid::CircularGrid: Circular grid.
flat::Bool=true: If the profile will be 2D, using rings, or 3D, using spherical shells.
error_bar::Bool=false: If the returned values will be compatible with errorbars! or with band! (default).
filter_function::Function=filterNothing: A function with the signature:
filter_function(data_dict) -> indices
where
- data_dict::Dict: A dictionary with the following shape:
  - :sim_data -> ::Simulation (see Simulation).
  - :snap_data -> ::Snapshot (see Snapshot).
  - :gc_data -> ::GroupCatalog (see GroupCatalog).
  - cell/particle type -> (block -> data of block, block -> data of block, ...).
  - cell/particle type -> (block -> data of block, block -> data of block, ...).
  - cell/particle type -> (block -> data of block, block -> data of block, ...).
  - ...
  - groupcat type -> (block -> data of block, block -> data of block, ...).
  - groupcat type -> (block -> data of block, block -> data of block, ...).
  - groupcat type -> (block -> data of block, block -> data of block, ...).
  - ...
- indices::Dict: A dictionary with the following shape:
  - cell/particle type -> idxs::IndexType
  - cell/particle type -> idxs::IndexType
  - cell/particle type -> idxs::IndexType
  - ...

Returns

A tuple with two elements:
- A vector with the position of each ring or spherical shells.
- A vector with the value quantity in each each ring or spherical shells.
It returns nothing if any of the necessary quantities are missing.

References

L. Blitz et al. (2006). The Role of Pressure in GMC Formation II: The H2-Pressure Relation. The Astrophysical Journal, 650(2), 933. doi:10.1086/505417

Data analysis functions

Signature for the plotSnapshot function

Expected signature:

Signature for the plotTimeSeries function

Expected signature:

Signature for the `plotSnapshot` function

Signature for the `plotTimeSeries` function