Various nongrid data containers.
yt.data_objects.data_containers.
GenerationInProgress
(fields)[source]¶Bases: Exception
args
¶with_traceback
()¶Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
yt.data_objects.data_containers.
ReconstructedObject
[source]¶Bases: tuple
count
(value) → integer  return number of occurrences of value¶index
(value[, start[, stop]]) → integer  return first index of value.¶Raises ValueError if the value is not present.
yt.data_objects.data_containers.
RegisteredDataContainer
(name, b, d)[source]¶Bases: type
mro
() → list¶return a type’s method resolution order
yt.data_objects.data_containers.
YTBooleanContainer
(op, dobj1, dobj2, ds=None, field_parameters=None, data_source=None)[source]¶Bases: yt.data_objects.data_containers.YTSelectionContainer3D
This is a boolean operation, accepting AND, OR, XOR, and NOT for combining multiple data objects.
This object is not designed to be created directly; it is designed to be created implicitly by using one of the bitwise operations (&, , ^, ~) on one or two other data objects. These correspond to the appropriate boolean operations, and the resultant object can be nested.
Parameters: 


Examples
>>> import yt
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> dd = ds.r[:,:,:]
>>> new_obj = sp ^ dd
>>> print(new_obj.sum("cell_volume"), dd.sum("cell_volume") 
... sp.sum("cell_volume"))
apply_units
(arr, units)¶argmax
(field, axis=None)¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶calculate_isocontour_flux
(field, value, field_x, field_y, field_z, fluxing_field=None)¶This identifies isocontours on a cellbycell basis, with no consideration of global connectedness, and calculates the flux over those contours.
This function will conduct marching cubes on all the cells in a given data container (gridbygrid), and then for each identified triangular segment of an isocontour in a given cell, calculate the gradient (i.e., normal) in the isocontoured field, interpolate the local value of the “fluxing” field, the area of the triangle, and then return:
area * local_flux_value * (n dot v)
Where area, local_value, and the vector v are interpolated at the barycenter (weighted by the vertex values) of the triangle. Note that this specifically allows for the field fluxing across the surface to be different from the field being contoured. If the fluxing_field is not specified, it is assumed to be 1.0 everywhere, and the raw flux with no localweighting is returned.
Additionally, the returned flux is defined as flux into the surface, not flux out of the surface.
Parameters: 


Returns:  flux – The summed flux. Note that it is not currently scaled; this is simply the codeunit area times the fields. 
Return type: 
Examples
This will create a data object, find a nice value in the center, and calculate the metal flux over it.
>>> dd = ds.all_data()
>>> rho = dd.quantities["WeightedAverageQuantity"](
... "Density", weight="CellMassMsun")
>>> flux = dd.calculate_isocontour_flux("Density", rho,
... "velocity_x", "velocity_y", "velocity_z", "Metal_Density")
chunks
(fields, chunking_style, **kwargs)¶clear_data
()¶Clears out all data from the YTDataContainer instance, freeing memory.
clone
()¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
comm
= None¶convert
(datatype)¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
cut_region
(field_cuts, field_parameters=None)¶Return a YTCutRegion, where the a cell is identified as being inside the cut region based on the value of one or more fields. Note that in previous versions of yt the name ‘grid’ was used to represent the data object used to construct the field cut, as of yt 3.0, this has been changed to ‘obj’.
Parameters: 


Examples
To find the total mass of hot gas with temperature greater than 10^6 K in your volume:
>>> ds = yt.load("RedshiftOutput0005")
>>> ad = ds.all_data()
>>> cr = ad.cut_region(["obj['temperature'] > 1e6"])
>>> print cr.quantities.total_quantity("cell_mass").in_units('Msun')
extract_connected_sets
(field, num_levels, min_val, max_val, log_space=True, cumulative=True)¶This function will create a set of contour objects, defined by having connected cell structures, which can then be studied and used to ‘paint’ their source grids, thus enabling them to be plotted.
Note that this function can return a connected set object that has no member values.
extract_isocontours
(field, value, filename=None, rescale=False, sample_values=None)¶This identifies isocontours on a cellbycell basis, with no consideration of global connectedness, and returns the vertices of the Triangles in that isocontour.
This function simply returns the vertices of all the triangles calculated by the marching cubes algorithm; for more complex operations, such as identifying connected sets of cells above a given threshold, see the extract_connected_sets function. This is more useful for calculating, for instance, total isocontour area, or visualizing in an external program (such as MeshLab.)
Parameters: 


Returns: 

Examples
This will create a data object, find a nice value in the center, and output the vertices to “triangles.obj” after rescaling them.
>>> dd = ds.all_data()
>>> rho = dd.quantities["WeightedAverageQuantity"](
... "Density", weight="CellMassMsun")
>>> verts = dd.extract_isocontours("Density", rho,
... "triangles.obj", True)
fcoords
¶fcoords_vertex
¶fwidth
¶get_data
(fields=None)¶get_dependencies
(fields)¶get_field_parameter
(name, default=None)¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
has_field_parameter
(name)¶Checks if a field parameter is set.
has_key
(key)¶Checks if a data field already exists.
icoords
¶index
¶integrate
(field, weight=None, axis=None)¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
ires
¶keys
()¶max
(field, axis=None)¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
paint_grids
(field, value, default_value=None)¶This function paints every cell in our dataset with a given value. If default_value is given, the other values for the given in every grid are discarded and replaced with default_value. Otherwise, the field is mandated to ‘know how to exist’ in the grid.
Note that this only paints the cells in the dataset, so cells in grids with child cells are left untouched.
particles
¶partition_index_2d
(axis)¶partition_index_3d
(ds, padding=0.0, rank_ratio=1)¶partition_index_3d_bisection_list
()¶Returns an array that is used to drive _partition_index_3d_bisection, below.
partition_region_3d
(left_edge, right_edge, padding=0.0, rank_ratio=1)¶Given a region, it subdivides it into smaller regions for parallel analysis.
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
selector
¶set_field_parameter
(name, val)¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_glue
(fields, label='yt', data_collection=None)¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
volume
()¶Return the volume of the data container. This is found by adding up the volume of the cells with centers in the container, rather than using the geometric shape of the container, so this may vary very slightly from what might be expected from the geometric volume.
write_out
(filename, fields=None, format='%0.16e')¶yt.data_objects.data_containers.
YTDataContainer
(ds, field_parameters)[source]¶Bases: object
Generic YTDataContainer container. By itself, will attempt to generate field, read fields (method defined by derived classes) and deal with passing back and forth field parameters.
argmax
(field, axis=None)[source]¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)[source]¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶clone
()[source]¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
convert
(datatype)[source]¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
get_field_parameter
(name, default=None)[source]¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
index
¶integrate
(field, weight=None, axis=None)[source]¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
max
(field, axis=None)[source]¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)[source]¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)[source]¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')[source]¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)[source]¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)[source]¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)[source]¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
set_field_parameter
(name, val)[source]¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)[source]¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)[source]¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)[source]¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_glue
(fields, label='yt', data_collection=None)[source]¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
yt.data_objects.data_containers.
YTSelectionContainer
(ds, field_parameters, data_source=None)[source]¶Bases: yt.data_objects.data_containers.YTDataContainer
, yt.utilities.parallel_tools.parallel_analysis_interface.ParallelAnalysisInterface
apply_units
(arr, units)¶argmax
(field, axis=None)¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶clear_data
()¶Clears out all data from the YTDataContainer instance, freeing memory.
clone
()¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
comm
= None¶convert
(datatype)¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
fcoords
¶fcoords_vertex
¶fwidth
¶get_dependencies
(fields)¶get_field_parameter
(name, default=None)¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
has_field_parameter
(name)¶Checks if a field parameter is set.
has_key
(key)¶Checks if a data field already exists.
icoords
¶index
¶integrate
(field, weight=None, axis=None)¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
ires
¶keys
()¶max
(field, axis=None)¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
partition_index_2d
(axis)¶partition_index_3d
(ds, padding=0.0, rank_ratio=1)¶partition_index_3d_bisection_list
()¶Returns an array that is used to drive _partition_index_3d_bisection, below.
partition_region_3d
(left_edge, right_edge, padding=0.0, rank_ratio=1)¶Given a region, it subdivides it into smaller regions for parallel analysis.
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
selector
¶set_field_parameter
(name, val)¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_glue
(fields, label='yt', data_collection=None)¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
write_out
(filename, fields=None, format='%0.16e')¶yt.data_objects.data_containers.
YTSelectionContainer0D
(ds, field_parameters=None, data_source=None)[source]¶Bases: yt.data_objects.data_containers.YTSelectionContainer
apply_units
(arr, units)¶argmax
(field, axis=None)¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶chunks
(fields, chunking_style, **kwargs)¶clear_data
()¶Clears out all data from the YTDataContainer instance, freeing memory.
clone
()¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
comm
= None¶convert
(datatype)¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
fcoords
¶fcoords_vertex
¶fwidth
¶get_data
(fields=None)¶get_dependencies
(fields)¶get_field_parameter
(name, default=None)¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
has_field_parameter
(name)¶Checks if a field parameter is set.
has_key
(key)¶Checks if a data field already exists.
icoords
¶index
¶integrate
(field, weight=None, axis=None)¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
ires
¶keys
()¶max
(field, axis=None)¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
partition_index_2d
(axis)¶partition_index_3d
(ds, padding=0.0, rank_ratio=1)¶partition_index_3d_bisection_list
()¶Returns an array that is used to drive _partition_index_3d_bisection, below.
partition_region_3d
(left_edge, right_edge, padding=0.0, rank_ratio=1)¶Given a region, it subdivides it into smaller regions for parallel analysis.
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
selector
¶set_field_parameter
(name, val)¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_glue
(fields, label='yt', data_collection=None)¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
write_out
(filename, fields=None, format='%0.16e')¶yt.data_objects.data_containers.
YTSelectionContainer1D
(ds, field_parameters=None, data_source=None)[source]¶Bases: yt.data_objects.data_containers.YTSelectionContainer
apply_units
(arr, units)¶argmax
(field, axis=None)¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶chunks
(fields, chunking_style, **kwargs)¶clear_data
()¶Clears out all data from the YTDataContainer instance, freeing memory.
clone
()¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
comm
= None¶convert
(datatype)¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
fcoords
¶fcoords_vertex
¶fwidth
¶get_data
(fields=None)¶get_dependencies
(fields)¶get_field_parameter
(name, default=None)¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
has_field_parameter
(name)¶Checks if a field parameter is set.
has_key
(key)¶Checks if a data field already exists.
icoords
¶index
¶integrate
(field, weight=None, axis=None)¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
ires
¶keys
()¶max
(field, axis=None)¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
partition_index_2d
(axis)¶partition_index_3d
(ds, padding=0.0, rank_ratio=1)¶partition_index_3d_bisection_list
()¶Returns an array that is used to drive _partition_index_3d_bisection, below.
partition_region_3d
(left_edge, right_edge, padding=0.0, rank_ratio=1)¶Given a region, it subdivides it into smaller regions for parallel analysis.
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
selector
¶set_field_parameter
(name, val)¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_glue
(fields, label='yt', data_collection=None)¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
write_out
(filename, fields=None, format='%0.16e')¶yt.data_objects.data_containers.
YTSelectionContainer2D
(axis, ds, field_parameters=None, data_source=None)[source]¶Bases: yt.data_objects.data_containers.YTSelectionContainer
apply_units
(arr, units)¶argmax
(field, axis=None)¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶chunks
(fields, chunking_style, **kwargs)¶clear_data
()¶Clears out all data from the YTDataContainer instance, freeing memory.
clone
()¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
comm
= None¶convert
(datatype)¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
fcoords
¶fcoords_vertex
¶fwidth
¶get_data
(fields=None)¶get_dependencies
(fields)¶get_field_parameter
(name, default=None)¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
has_field_parameter
(name)¶Checks if a field parameter is set.
has_key
(key)¶Checks if a data field already exists.
icoords
¶index
¶integrate
(field, weight=None, axis=None)¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
ires
¶keys
()¶max
(field, axis=None)¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
partition_index_2d
(axis)¶partition_index_3d
(ds, padding=0.0, rank_ratio=1)¶partition_index_3d_bisection_list
()¶Returns an array that is used to drive _partition_index_3d_bisection, below.
partition_region_3d
(left_edge, right_edge, padding=0.0, rank_ratio=1)¶Given a region, it subdivides it into smaller regions for parallel analysis.
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
selector
¶set_field_parameter
(name, val)¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_frb
(width, resolution, center=None, height=None, periodic=False)[source]¶This function returns a FixedResolutionBuffer generated from this object.
A FixedResolutionBuffer is an object that accepts a variableresolution 2D object and transforms it into an NxM bitmap that can be plotted, examined or processed. This is a convenience function to return an FRB directly from an existing 2D data object.
Parameters: 


Returns:  frb – A fixed resolution buffer, which can be queried for fields. 
Return type: 
Examples
>>> proj = ds.proj("Density", 0)
>>> frb = proj.to_frb( (100.0, 'kpc'), 1024)
>>> write_image(np.log10(frb["Density"]), 'density_100kpc.png')
to_glue
(fields, label='yt', data_collection=None)¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
write_out
(filename, fields=None, format='%0.16e')¶yt.data_objects.data_containers.
YTSelectionContainer3D
(center, ds, field_parameters=None, data_source=None)[source]¶Bases: yt.data_objects.data_containers.YTSelectionContainer
Returns an instance of YTSelectionContainer3D, or prepares one. Usually only used as a base class. Note that center is supplied, but only used for fields and quantities that require it.
apply_units
(arr, units)¶argmax
(field, axis=None)¶Return the values at which the field is maximized.
This will, in a parallelaware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_max_rho = reg.argmax("density", axis="temperature")
>>> max_rho_xyz = reg.argmax("density")
>>> t_mrho, v_mrho = reg.argmax("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmax("density")
argmin
(field, axis=None)¶Return the values at which the field is minimized.
This will, in a parallelaware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field
Parameters: 


Returns:  
Return type:  A list of YTQuantities as specified by the axis argument. 
Examples
>>> temp_at_min_rho = reg.argmin("density", axis="temperature")
>>> min_rho_xyz = reg.argmin("density")
>>> t_mrho, v_mrho = reg.argmin("density", axis=["temperature",
... "velocity_magnitude"])
>>> x, y, z = reg.argmin("density")
blocks
¶calculate_isocontour_flux
(field, value, field_x, field_y, field_z, fluxing_field=None)[source]¶This identifies isocontours on a cellbycell basis, with no consideration of global connectedness, and calculates the flux over those contours.
This function will conduct marching cubes on all the cells in a given data container (gridbygrid), and then for each identified triangular segment of an isocontour in a given cell, calculate the gradient (i.e., normal) in the isocontoured field, interpolate the local value of the “fluxing” field, the area of the triangle, and then return:
area * local_flux_value * (n dot v)
Where area, local_value, and the vector v are interpolated at the barycenter (weighted by the vertex values) of the triangle. Note that this specifically allows for the field fluxing across the surface to be different from the field being contoured. If the fluxing_field is not specified, it is assumed to be 1.0 everywhere, and the raw flux with no localweighting is returned.
Additionally, the returned flux is defined as flux into the surface, not flux out of the surface.
Parameters: 


Returns:  flux – The summed flux. Note that it is not currently scaled; this is simply the codeunit area times the fields. 
Return type: 
Examples
This will create a data object, find a nice value in the center, and calculate the metal flux over it.
>>> dd = ds.all_data()
>>> rho = dd.quantities["WeightedAverageQuantity"](
... "Density", weight="CellMassMsun")
>>> flux = dd.calculate_isocontour_flux("Density", rho,
... "velocity_x", "velocity_y", "velocity_z", "Metal_Density")
chunks
(fields, chunking_style, **kwargs)¶clear_data
()¶Clears out all data from the YTDataContainer instance, freeing memory.
clone
()¶Clone a data object.
This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeplycopied. If you modify the field parameters inplace, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.
Notes
One use case for this is to have multiple identical data objects that are being chunked over in different orders.
Examples
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp["density"]
>>> print sp.field_data.keys()
[("gas", "density")]
>>> print sp_clone.field_data.keys()
[]
comm
= None¶convert
(datatype)¶This will attempt to convert a given unit to cgs from code units. It either returns the multiplicative factor or throws a KeyError.
cut_region
(field_cuts, field_parameters=None)[source]¶Return a YTCutRegion, where the a cell is identified as being inside the cut region based on the value of one or more fields. Note that in previous versions of yt the name ‘grid’ was used to represent the data object used to construct the field cut, as of yt 3.0, this has been changed to ‘obj’.
Parameters: 


Examples
To find the total mass of hot gas with temperature greater than 10^6 K in your volume:
>>> ds = yt.load("RedshiftOutput0005")
>>> ad = ds.all_data()
>>> cr = ad.cut_region(["obj['temperature'] > 1e6"])
>>> print cr.quantities.total_quantity("cell_mass").in_units('Msun')
extract_connected_sets
(field, num_levels, min_val, max_val, log_space=True, cumulative=True)[source]¶This function will create a set of contour objects, defined by having connected cell structures, which can then be studied and used to ‘paint’ their source grids, thus enabling them to be plotted.
Note that this function can return a connected set object that has no member values.
extract_isocontours
(field, value, filename=None, rescale=False, sample_values=None)[source]¶This identifies isocontours on a cellbycell basis, with no consideration of global connectedness, and returns the vertices of the Triangles in that isocontour.
This function simply returns the vertices of all the triangles calculated by the marching cubes algorithm; for more complex operations, such as identifying connected sets of cells above a given threshold, see the extract_connected_sets function. This is more useful for calculating, for instance, total isocontour area, or visualizing in an external program (such as MeshLab.)
Parameters: 


Returns: 

Examples
This will create a data object, find a nice value in the center, and output the vertices to “triangles.obj” after rescaling them.
>>> dd = ds.all_data()
>>> rho = dd.quantities["WeightedAverageQuantity"](
... "Density", weight="CellMassMsun")
>>> verts = dd.extract_isocontours("Density", rho,
... "triangles.obj", True)
fcoords
¶fcoords_vertex
¶fwidth
¶get_data
(fields=None)¶get_dependencies
(fields)¶get_field_parameter
(name, default=None)¶This is typically only used by derived field functions, but it returns parameters used to generate fields.
has_field_parameter
(name)¶Checks if a field parameter is set.
has_key
(key)¶Checks if a data field already exists.
icoords
¶index
¶integrate
(field, weight=None, axis=None)¶Compute the integral (projection) of a field along an axis.
This projects a field along an axis.
Parameters:  

Returns:  
Return type:  YTProjection 
Examples
>>> column_density = reg.integrate("density", axis="z")
ires
¶keys
()¶max
(field, axis=None)¶Compute the maximum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> max_temp = reg.max("temperature")
>>> max_temp_proj = reg.max("temperature", axis="x")
mean
(field, axis=None, weight=None)¶Compute the mean of a field, optionally along an axis, with a weight.
This will, in a parallelaware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.
Parameters:  

Returns:  
Return type:  Scalar or YTProjection. 
Examples
>>> avg_rho = reg.mean("density", weight="cell_volume")
>>> rho_weighted_T = reg.mean("temperature", axis="y", weight="density")
min
(field, axis=None)¶Compute the minimum of a field.
This will, in a parallelaware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.
Parameters:  

Returns:  
Return type:  Scalar. 
Examples
>>> min_temp = reg.min("temperature")
paint_grids
(field, value, default_value=None)[source]¶This function paints every cell in our dataset with a given value. If default_value is given, the other values for the given in every grid are discarded and replaced with default_value. Otherwise, the field is mandated to ‘know how to exist’ in the grid.
Note that this only paints the cells in the dataset, so cells in grids with child cells are left untouched.
particles
¶partition_index_2d
(axis)¶partition_index_3d
(ds, padding=0.0, rank_ratio=1)¶partition_index_3d_bisection_list
()¶Returns an array that is used to drive _partition_index_3d_bisection, below.
partition_region_3d
(left_edge, right_edge, padding=0.0, rank_ratio=1)¶Given a region, it subdivides it into smaller regions for parallel analysis.
pf
¶profile
(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, deposition='ngp')¶Create a 1, 2, or 3D profile object from this data_source.
The dimensionality of the profile object is chosen by the number of
fields given in the bin_fields argument. This simply calls
yt.data_objects.profiles.create_profile()
.
Parameters: 


Examples
Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].
>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(ad, [("gas", "density")],
... [("gas", "temperature"),
... ("gas", "velocity_x")])
>>> print (profile.x)
>>> print (profile["gas", "temperature"])
>>> plot = profile.plot()
ptp
(field)¶Compute the range of values (maximum  minimum) of a field.
This will, in a parallelaware fashion, compute the “peaktopeak” of the given field.
Parameters:  field (string or tuple field name) – The field to average. 

Returns:  
Return type:  Scalar 
Examples
>>> rho_range = reg.ptp("density")
save_as_dataset
(filename=None, fields=None)¶Export a data object to a reloadable yt dataset.
This function will take a data object and output a dataset
containing either the fields presently existing or fields
given in the fields
list. The resulting dataset can be
reloaded as a yt dataset.
Parameters: 


Returns:  filename – The name of the file that has been created. 
Return type: 
Examples
>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=["density", "temperature"])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print (sds.data["density"])
[ 4.46237613e32 4.86830178e32 4.46335118e32 ..., 6.43956165e30
3.57339907e30 2.83150720e30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print (ad["temperature"])
[ 1.00000000e+00 1.00000000e+00 1.00000000e+00 ..., 4.40108359e+04
4.54380547e+04 4.72560117e+04] K
save_object
(name, filename=None)¶Save an object. If filename is supplied, it will be stored in
a shelve
file of that name. Otherwise, it will be stored via
yt.data_objects.api.GridIndex.save_object()
.
selector
¶set_field_parameter
(name, val)¶Here we set up dictionaries that get passed up and down and ultimately to derived fields.
std
(field, weight=None)¶Compute the variance of a field.
This will, in a parallelware fashion, compute the variance of the given field.
Parameters:  

Returns:  
Return type:  Scalar 
sum
(field, axis=None)¶Compute the sum of a field, optionally along an axis.
This will, in a parallelaware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.
Parameters:  

Returns:  
Return type:  Either a scalar or a YTProjection. 
Examples
>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum("ones", axis="x")
tiles
¶to_dataframe
(fields=None)¶Export a data object to a pandas DataFrame.
This function will take a data object and construct from it and optionally a list of fields a pandas DataFrame object. If pandas is not importable, this will raise ImportError.
Parameters:  fields (list of strings or tuple field names, default None) – If this is supplied, it is the list of fields to be exported into the data frame. If not supplied, whatever fields presently exist will be used. 

Returns:  df – The data contained in the object. 
Return type:  DataFrame 
Examples
>>> dd = ds.all_data()
>>> df1 = dd.to_dataframe(["density", "temperature"])
>>> dd["velocity_magnitude"]
>>> df2 = dd.to_dataframe()
to_glue
(fields, label='yt', data_collection=None)¶Takes specific fields in the container and exports them to Glue (http://www.glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.
volume
()[source]¶Return the volume of the data container. This is found by adding up the volume of the cells with centers in the container, rather than using the geometric shape of the container, so this may vary very slightly from what might be expected from the geometric volume.
write_out
(filename, fields=None, format='%0.16e')¶