yt.lagos.DerivedField

class yt.lagos.DerivedField(name, function, convert_function=None, particle_convert_function=None, units='', projected_units='', take_log=True, validators=None, particle_type=False, vector_field=False, display_field=True, not_in_all=False, display_name=None, projection_conversion='cm')

This is the base class used to describe a cell-by-cell derived field.

Parameters:

• name – is the name of the field.
• function – is a function handle that defines the field
• convert_function – must convert to CGS, if it needs to be done
• units – is a mathtext-formatted string that describes the field
• projected_units – if we display a projection, what should the units be?
• take_log – describes whether the field should be logged
• validators – is a list of FieldValidator objects
• particle_type – is this field based on particles?
• vector_field – describes the dimensionality of the field
• display_field – governs its appearance in the dropdowns in reason
• not_in_all – is used for baryon fields from the data that are not in all the grids
• display_name – a name used in the plots
• projection_conversion – which unit should we multiply by in a projection?

Methods

check_available(data)	This raises an exception of the appropriate type if the set of
get_dependencies(*args, **kwargs)	This returns a list of names of fields that this field depends on.
get_label([projected])	Return a data label for the given field, inluding units.
get_projected_units()	Return a string describing the units if the field has been projected.
get_source()	Return a string containing the source of the function (if possible.)
get_units()	Return a string describing the units.
particle_convert(data)