velociraptor.catalogue.registration module

Default registration functions.

If you add one, don’t forget to add it to global_registration_functions at the end of the file.

velociraptor.catalogue.registration.registration_fail_all(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Basic registration function showing function signature that is required and automatically fails all tests against itself.

Function signature:

• field_path: the name of the field
• unit_system: a VelociraptorUnits instance that contains all unit information that is available from the velociraptor catalogue

Return signature:

• field_units: the units that correspond to field_path.
• name: A fancy (possibly LaTeX’d) name for the field.
• snake_case: A correct snake_case name for the field.

velociraptor.catalogue.registration.registration_apertures(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers aperture values by searching them with regex.

velociraptor.catalogue.registration.registration_projected_apertures(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers aperture values by searching them with regex.

velociraptor.catalogue.registration.registration_energies(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers all energy related quantities (those beginning with E).

velociraptor.catalogue.registration.registration_ids(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers all quantities related to particle ids and halo ids (those beginning or ending with ID).

velociraptor.catalogue.registration.registration_rotational_support(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers rotational support quantities (those beginning with K). Note that this corresponds to kappa in Sales+2010 _not_ K.

velociraptor.catalogue.registration.registration_angular_momentum(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers values starting with L, those that represent angular momenta.

velociraptor.catalogue.registration.registration_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registration for all mass-based quantities. (Start with M)

velociraptor.catalogue.registration.registration_rvmax_quantities(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registration for all quantities measured within RVmax (Start with RVmax)

velociraptor.catalogue.registration.registration_radii(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registration for all radii quantities (start with R_)

velociraptor.catalogue.registration.registration_star_formation_rate(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers star formation rate quantities. (Start with SFR)

velociraptor.catalogue.registration.registration_temperature(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers temperature based quantites (Those beginning with T).

velociraptor.catalogue.registration.registration_structure_type(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the StructureType field.

velociraptor.catalogue.registration.registration_velocities(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers velocity quantities (those starting with V).

velociraptor.catalogue.registration.registration_positions(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers all positon based quantities (those beginning with X, Y, or Z).

velociraptor.catalogue.registration.registration_concentration(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers concentration values (those beginning with c).

velociraptor.catalogue.registration.registration_metallicity(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers metallicity-based quantities (those beginning with Zmet)

velociraptor.catalogue.registration.registration_eigenvectors(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers eigenvector quantities (those beginning with eig).

velociraptor.catalogue.registration.registration_veldisp(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers velocity dispersion quantities (those beginning with veldisp).

velociraptor.catalogue.registration.registration_stellar_age(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the stellar ages properties (currently tage_star).

velociraptor.catalogue.registration.registration_element_mass_fractions(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the element mass fraction properties.

Hopefully this is changed in the future as this is a mess.

velociraptor.catalogue.registration.registration_dust_mass_fractions(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the dust mass fraction properties.

Hopefully this is changed in the future as this is a mess.

velociraptor.catalogue.registration.registration_number(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the number of particles in each halo (n_{bh, gas, star} and npart).

velociraptor.catalogue.registration.registration_gas_H_and_He_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the masses in Hydrogen & Helium within apertures

velociraptor.catalogue.registration.registration_gas_diffuse_element_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the masses in Hydrogen & Helium within apertures

velociraptor.catalogue.registration.registration_dust_masses_from_table(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the dust mass fraction properties.

velociraptor.catalogue.registration.registration_gas_hydrogen_species_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the masses in hydrogen species within apertures.

velociraptor.catalogue.registration.registration_cold_dense_gas_properties(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the mass of cold (T < 10^4.5 K), dense (nH > 0.1 cm^-3) gas in apertures.

velociraptor.catalogue.registration.registration_log_element_ratios_times_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the log10(Fe/H) times mass and log10(O/H) times mass within apertures for two particle floor values

velociraptor.catalogue.registration.registration_lin_element_ratios_times_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the Fe/H times mass and O/H times mass within apertures for two particle floor values

velociraptor.catalogue.registration.registration_dust_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the masses in dust within apertures

velociraptor.catalogue.registration.registration_stellar_luminosities(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the luminosities within apertures

velociraptor.catalogue.registration.registration_hydrogen_phase_fractions(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the phase fractions for hydrogen.

velociraptor.catalogue.registration.registration_black_hole_masses(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Sub-grid black hole property registrations.

velociraptor.catalogue.registration.registration_stellar_birth_densities(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Stellar birth density registrations.

velociraptor.catalogue.registration.registration_snii_thermal_feedback_densities(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

SNII thermal feedback density registrations.

velociraptor.catalogue.registration.registration_species_fractions(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the species mass fraction properties.

Hopefully this is changed in the future as this is a mess.

velociraptor.catalogue.registration.registration_spherical_overdensities(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers SO aperture values by searching them with regex.

velociraptor.catalogue.registration.registration_element_masses_in_stars(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers element masses contained in stars

velociraptor.catalogue.registration.registration_snia_rates(field_path: str, unit_system: velociraptor.units.VelociraptorUnits) -> (<class 'unyt.unit_object.Unit'>, <class 'str'>, <class 'str'>)

Registers the SNIa rates within apertures