yt.frontends.rockstar.fields module

class yt.frontends.rockstar.fields.RockstarFieldInfo(ds, field_list, slice_info=None)[source]

Bases: yt.fields.field_info_container.FieldInfoContainer

add_deprecated_field(name, function, sampling_type, since, removal, ret_name=None, **kwargs)

Add a new field which is deprecated, along with supplemental metadata, to the list of available fields. This respects a number of arguments, all of which are passed on to the constructor for DerivedField.

Parameters
  • name (str) – is the name of the field.

  • function (callable) – A function handle that defines the field. Should accept arguments (field, data)

  • sampling_type (str) – “cell” or “particle” or “local”

  • since (str) – The version string marking when this field was deprecated.

  • removal (str) – The version string marking when this field will be removed.

  • ret_name (str) – The name of the field which will actually be returned, used only by alias().

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^). If set to “auto” the units will be inferred from the return value of the field function.

  • take_log (bool) – Describes whether the field should be logged

  • validators (list) – A list of FieldValidator objects

  • vector_field (bool) – Describes the dimensionality of the field. Currently unused.

  • display_name (str) – A name used in the plots

add_field(name, function, sampling_type, **kwargs)

Add a new field, along with supplemental metadata, to the list of available fields. This respects a number of arguments, all of which are passed on to the constructor for DerivedField.

Parameters
  • name (str) – is the name of the field.

  • function (callable) – A function handle that defines the field. Should accept arguments (field, data)

  • sampling_type (str) – “cell” or “particle” or “local”

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^). If set to “auto” the units will be inferred from the return value of the field function.

  • take_log (bool) – Describes whether the field should be logged

  • validators (list) – A list of FieldValidator objects

  • vector_field (bool) – Describes the dimensionality of the field. Currently unused.

  • display_name (str) – A name used in the plots

add_output_field(name, sampling_type, **kwargs)
alias(alias_name, original_name, units=None, deprecate: Optional[Tuple[str]] = None)

Alias one field to another field.

Parameters
  • alias_name (Tuple[str]) – The new field name.

  • original_name (Tuple[str]) – The field to be aliased.

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^). If set to “auto” the units will be inferred from the return value of the field function.

  • deprecate (Tuple[str], optional) – If this is set, then the tuple contains two string version numbers: the first marking the version when the field was deprecated, and the second marking when the field will be removed.

check_derived_fields(fields_to_check=None)
clear() → None. Remove all items from D.
copy() → a shallow copy of D
classmethod create_with_fallback(fallback, name='')
extra_union_fields = ()
fallback = None
find_dependencies(loaded)
fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

has_key(key)
items() → a set-like object providing a view on D’s items
keys() → a set-like object providing a view on D’s keys
known_other_fields = ()
known_particle_fields = (('particle_identifier', ('', [], None)), ('particle_position_x', ('Mpccm / h', [], None)), ('particle_position_y', ('Mpccm / h', [], None)), ('particle_position_z', ('Mpccm / h', [], None)), ('particle_velocity_x', ('km / s', [], None)), ('particle_velocity_y', ('km / s', [], None)), ('particle_velocity_z', ('km / s', [], None)), ('particle_corevel_x', ('km / s', [], None)), ('particle_corevel_y', ('km / s', [], None)), ('particle_corevel_z', ('km / s', [], None)), ('particle_bulkvel_x', ('km / s', [], None)), ('particle_bulkvel_y', ('km / s', [], None)), ('particle_bulkvel_z', ('km / s', [], None)), ('particle_mass', ('Msun / h', [], 'Mass')), ('virial_radius', ('kpccm / h', [], 'Radius')), ('child_r', ('kpccm / h', [], None)), ('vmax_r', ('km / s', [], None)), ('mgrav', ('', [], None)), ('vmax', ('km / s', [], 'V_{max}')), ('rvmax', ('km / s', [], None)), ('rs', ('kpccm / h', [], 'R_s')), ('klypin_rs', ('kpccm / h', [], 'Klypin R_s')), ('vrms', ('km / s', [], 'V_{rms}')), ('Jx', ('', [], 'J_x')), ('Jy', ('', [], 'J_y')), ('Jz', ('', [], 'J_z')), ('energy', ('', [], None)), ('spin', ('', [], 'Spin Parameter')), ('alt_m1', ('Msun / h', [], None)), ('alt_m2', ('Msun / h', [], None)), ('alt_m3', ('Msun / h', [], None)), ('alt_m4', ('Msun / h', [], None)), ('Xoff', ('', [], None)), ('Voff', ('', [], None)), ('b_to_a', ('', [], 'Ellipsoidal b to a')), ('c_to_a', ('', [], 'Ellipsoidal c to a')), ('Ax', ('', [], 'A_x')), ('Ay', ('', [], 'A_y')), ('Az', ('', [], 'A_z')), ('b_to_a2', ('', [], None)), ('c_to_a2', ('', [], None)), ('A2x', ('', [], 'A2_x')), ('A2y', ('', [], 'A2_y')), ('A2z', ('', [], 'A2_z')), ('bullock_spin', ('', [], 'Bullock Spin Parameter')), ('kin_to_pot', ('', [], 'Kinetic to Potential')), ('m_pe_b', ('', [], None)), ('m_pe_d', ('', [], None)), ('num_p', ('', [], 'Number of Particles')), ('num_child_particles', ('', [], 'Number of Child Particles')), ('p_start', ('', [], None)), ('desc', ('', [], None)), ('flags', ('', [], None)), ('n_core', ('', [], None)), ('min_pos_err', ('', [], None)), ('min_vel_err', ('', [], None)), ('min_bulkvel_err', ('', [], None)))
load_all_plugins(ftype='gas')
load_plugin(plugin_name, ftype='gas', skip_check=False)
pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

setup_extra_union_fields(ptype='all')
setup_fluid_aliases(ftype='gas')
setup_fluid_fields()
setup_fluid_index_fields()
setup_particle_fields(ptype, ftype='gas', num_neighbors=64)
setup_smoothed_fields(ptype, num_neighbors=64, ftype='gas')
update([E, ]**F) → None. Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D’s values