yt.frontends.ahf.fields module¶

class yt.frontends.ahf.fields.AHFHalosFieldInfo(ds, field_list: list[tuple[str, str]], slice_info=None)[source]¶

Bases: FieldInfoContainer

add_deprecated_field(name, function, sampling_type, since, removal=None, 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: tuple[str, str], function: Callable, sampling_type: str, *, alias: DerivedField | None = None, force_override: bool = False, **kwargs) → None¶

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 (tuple[str, str]) – field (or particle) type, field name
function (callable) – A function handle that defines the field. Should accept arguments (field, data)
sampling_type (str) – “cell” or “particle” or “local”
force_override (bool) – If False (default), an error will be raised if a field of the same name already exists.
alias (DerivedField (optional):) – existing 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.
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: tuple[str, str], original_name: tuple[str, str], units: str | None = None, deprecate: tuple[str, str | None] | None = None)¶

Alias one field to another field.

Parameters:

alias_name (tuple[str, str]) – The new field name.
original_name (tuple[str, 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, str | None] | None) – 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()¶

classmethod create_with_fallback(fallback, name='')¶

property curvilinear: bool¶

extra_union_fields: tuple[FieldKey, ...] = ()¶

fallback = None¶

find_dependencies(loaded)¶

classmethod fromkeys(iterable, value=None)¶

get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶

get_aliases_gallery() → list[str]¶

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: KnownFieldsT = ()¶

known_particle_fields: tuple[tuple[str, tuple[str, list[str], str | None]], ...] = (('ID', ('', ['particle_identifier'], None)), ('hostHalo', ('', [], None)), ('numSubStruct', ('', [], None)), ('Mvir', ('Msun/h', ['particle_mass'], 'Virial Mass')), ('npart', ('', [], None)), ('Xc', ('kpccm/h', ['particle_position_x'], None)), ('Yc', ('kpccm/h', ['particle_position_y'], None)), ('Zc', ('kpccm/h', ['particle_position_z'], None)), ('VXc', ('km/s', ['particle_velocity_x'], None)), ('VYc', ('km/s', ['particle_velocity_y'], None)), ('VZc', ('km/s', ['particle_velocity_z'], None)), ('Rvir', ('kpccm/h', ['virial_radius'], 'Virial Radius')), ('Rmax', ('kpccm/h', [], None)), ('r2', ('kpccm/h', [], None)), ('mbp_offset', ('kpccm/h', [], None)), ('com_offset', ('kpccm/h', [], None)), ('Vmax', ('km/s', [], None)), ('v_sec', ('km/s', [], None)), ('sigV', ('km/s', [], None)), ('lambda', ('', [], None)), ('lambdaE', ('', [], None)), ('Lx', ('', [], None)), ('Ly', ('', [], None)), ('Lz', ('', [], None)), ('b', ('', [], None)), ('c', ('', [], None)), ('Eax', ('', [], None)), ('Eay', ('', [], None)), ('Eaz', ('', [], None)), ('Ebx', ('', [], None)), ('Eby', ('', [], None)), ('Ebz', ('', [], None)), ('Ecx', ('', [], None)), ('Ecy', ('', [], None)), ('Ecz', ('', [], None)), ('ovdens', ('', [], None)), ('nbins', ('', [], None)), ('fMhires', ('', [], None)), ('Ekin', ('Msun/h*(km/s)**2', [], None)), ('Epot', ('Msun/h*(km/s)**2', [], None)), ('SurfP', ('Msun/h*(km/s)**2', [], None)), ('Phi0', ('(km/s)**2', [], None)), ('cNFW', ('', [], None)))¶

load_all_plugins(ftype: str | None = 'gas') → None¶

load_plugin(plugin_name: str, ftype: str = 'gas', skip_check: bool = 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() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

setup_extra_union_fields(ptype='all')¶

setup_fluid_aliases(ftype: str = 'gas') → None¶

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 mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

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