1.. _api-reference:
2
3API Reference
4=============
5
6Plots and the Plotting Interface
7--------------------------------
8
9SlicePlot and ProjectionPlot
10^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11
12.. autosummary::
13
14   ~yt.visualization.plot_window.SlicePlot
15   ~yt.visualization.plot_window.AxisAlignedSlicePlot
16   ~yt.visualization.plot_window.OffAxisSlicePlot
17   ~yt.visualization.plot_window.ProjectionPlot
18   ~yt.visualization.plot_window.OffAxisProjectionPlot
19   ~yt.visualization.plot_window.WindowPlotMPL
20   ~yt.visualization.plot_window.PlotWindow
21   ~yt.visualization.plot_window.plot_2d
22
23ProfilePlot and PhasePlot
24^^^^^^^^^^^^^^^^^^^^^^^^^
25
26.. autosummary::
27
28   ~yt.visualization.profile_plotter.ProfilePlot
29   ~yt.visualization.profile_plotter.PhasePlot
30   ~yt.visualization.profile_plotter.PhasePlotMPL
31
32Particle Plots
33^^^^^^^^^^^^^^
34
35.. autosummary::
36
37   ~yt.visualization.particle_plots.ParticleProjectionPlot
38   ~yt.visualization.particle_plots.ParticlePhasePlot
39   ~yt.visualization.particle_plots.ParticlePlot
40
41Fixed Resolution Pixelization
42^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43
44.. autosummary::
45
46   ~yt.visualization.fixed_resolution.FixedResolutionBuffer
47   ~yt.visualization.fixed_resolution.ParticleImageBuffer
48   ~yt.visualization.fixed_resolution.CylindricalFixedResolutionBuffer
49   ~yt.visualization.fixed_resolution.OffAxisProjectionFixedResolutionBuffer
50
51Writing FITS images
52^^^^^^^^^^^^^^^^^^^
53
54.. autosummary::
55
56   ~yt.visualization.fits_image.FITSImageData
57   ~yt.visualization.fits_image.FITSSlice
58   ~yt.visualization.fits_image.FITSProjection
59   ~yt.visualization.fits_image.FITSOffAxisSlice
60   ~yt.visualization.fits_image.FITSOffAxisProjection
61   ~yt.visualization.fits_image.FITSParticleProjection
62
63Data Sources
64------------
65
66.. _physical-object-api:
67
68Physical Objects
69^^^^^^^^^^^^^^^^
70
71These are the objects that act as physical selections of data, describing a
72region in space.  These are not typically addressed directly; see
73:ref:`available-objects` for more information.
74
75Base Classes
76++++++++++++
77
78These will almost never need to be instantiated on their own.
79
80.. autosummary::
81
82   ~yt.data_objects.data_containers.YTDataContainer
83   ~yt.data_objects.selection_objects.data_selection_objects.YTSelectionContainer
84   ~yt.data_objects.selection_objects.data_selection_objects.YTSelectionContainer0D
85   ~yt.data_objects.selection_objects.data_selection_objects.YTSelectionContainer1D
86   ~yt.data_objects.selection_objects.data_selection_objects.YTSelectionContainer2D
87   ~yt.data_objects.selection_objects.data_selection_objects.YTSelectionContainer3D
88
89Selection Objects
90+++++++++++++++++
91
92These objects are defined by some selection method or mechanism.  Most are
93geometric.
94
95.. autosummary::
96
97   ~yt.data_objects.selection_objects.point.YTPoint
98   ~yt.data_objects.selection_objects.ray.YTOrthoRay
99   ~yt.data_objects.selection_objects.ray.YTRay
100   ~yt.data_objects.selection_objects.slices.YTSlice
101   ~yt.data_objects.selection_objects.slices.YTCuttingPlane
102   ~yt.data_objects.selection_objects.disk.YTDisk
103   ~yt.data_objects.selection_objects.region.YTRegion
104   ~yt.data_objects.selection_objects.object_collection.YTDataCollection
105   ~yt.data_objects.selection_objects.spheroids.YTSphere
106   ~yt.data_objects.selection_objects.spheroids.YTEllipsoid
107   ~yt.data_objects.selection_objects.cut_region.YTCutRegion
108   ~yt.data_objects.index_subobjects.grid_patch.AMRGridPatch
109   ~yt.data_objects.index_subobjects.octree_subset.OctreeSubset
110   ~yt.data_objects.index_subobjects.particle_container.ParticleContainer
111   ~yt.data_objects.index_subobjects.unstructured_mesh.UnstructuredMesh
112   ~yt.data_objects.index_subobjects.unstructured_mesh.SemiStructuredMesh
113
114Construction Objects
115++++++++++++++++++++
116
117These objects typically require some effort to build.  Often this means
118integrating through the simulation in some way, or creating some large or
119expensive set of intermediate data.
120
121.. autosummary::
122
123   ~yt.data_objects.construction_data_containers.YTStreamline
124   ~yt.data_objects.construction_data_containers.YTQuadTreeProj
125   ~yt.data_objects.construction_data_containers.YTCoveringGrid
126   ~yt.data_objects.construction_data_containers.YTArbitraryGrid
127   ~yt.data_objects.construction_data_containers.YTSmoothedCoveringGrid
128   ~yt.data_objects.construction_data_containers.YTSurface
129
130Time Series Objects
131^^^^^^^^^^^^^^^^^^^
132
133These are objects that either contain and represent or operate on series of
134datasets.
135
136.. autosummary::
137
138   ~yt.data_objects.time_series.DatasetSeries
139   ~yt.data_objects.time_series.DatasetSeriesObject
140   ~yt.data_objects.time_series.SimulationTimeSeries
141   ~yt.data_objects.time_series.TimeSeriesQuantitiesContainer
142   ~yt.data_objects.time_series.AnalysisTaskProxy
143   ~yt.data_objects.particle_trajectories.ParticleTrajectories
144
145Geometry Handlers
146-----------------
147
148These objects generate an "index" into multiresolution data.
149
150.. autosummary::
151
152   ~yt.geometry.geometry_handler.Index
153   ~yt.geometry.grid_geometry_handler.GridIndex
154   ~yt.geometry.oct_geometry_handler.OctreeIndex
155   ~yt.geometry.particle_geometry_handler.ParticleIndex
156   ~yt.geometry.unstructured_mesh_handler.UnstructuredIndex
157
158Units
159-----
160
161yt's symbolic unit handling system is now based on the external library unyt. In
162complement, Dataset objects support the following methods to build arrays and
163scalars with physical dimensions.
164
165.. autosummary::
166
167   yt.data_objects.static_output.Dataset.arr
168   yt.data_objects.static_output.Dataset.quan
169
170
171
172Frontends
173---------
174
175.. autosummary::
176
177AMRVAC
178^^^^^^
179
180.. autosummary::
181
182   ~yt.frontends.amrvac.data_structures.AMRVACGrid
183   ~yt.frontends.amrvac.data_structures.AMRVACHierarchy
184   ~yt.frontends.amrvac.data_structures.AMRVACDataset
185   ~yt.frontends.amrvac.fields.AMRVACFieldInfo
186   ~yt.frontends.amrvac.io.AMRVACIOHandler
187   ~yt.frontends.amrvac.io.read_amrvac_namelist
188
189ARTIO
190^^^^^
191
192.. autosummary::
193
194   ~yt.frontends.artio.data_structures.ARTIOIndex
195   ~yt.frontends.artio.data_structures.ARTIOOctreeSubset
196   ~yt.frontends.artio.data_structures.ARTIORootMeshSubset
197   ~yt.frontends.artio.data_structures.ARTIODataset
198   ~yt.frontends.artio.definitions.ARTIOconstants
199   ~yt.frontends.artio.fields.ARTIOFieldInfo
200   ~yt.frontends.artio.io.IOHandlerARTIO
201
202
203Athena
204^^^^^^
205
206.. autosummary::
207
208   ~yt.frontends.athena.data_structures.AthenaGrid
209   ~yt.frontends.athena.data_structures.AthenaHierarchy
210   ~yt.frontends.athena.data_structures.AthenaDataset
211   ~yt.frontends.athena.fields.AthenaFieldInfo
212   ~yt.frontends.athena.io.IOHandlerAthena
213
214AMReX/Boxlib
215^^^^^^^^^^^^
216
217.. autosummary::
218
219   ~yt.frontends.boxlib.data_structures.BoxlibGrid
220   ~yt.frontends.boxlib.data_structures.BoxlibHierarchy
221   ~yt.frontends.boxlib.data_structures.BoxlibDataset
222   ~yt.frontends.boxlib.data_structures.CastroDataset
223   ~yt.frontends.boxlib.data_structures.MaestroDataset
224   ~yt.frontends.boxlib.data_structures.NyxHierarchy
225   ~yt.frontends.boxlib.data_structures.NyxDataset
226   ~yt.frontends.boxlib.data_structures.OrionHierarchy
227   ~yt.frontends.boxlib.data_structures.OrionDataset
228   ~yt.frontends.boxlib.fields.BoxlibFieldInfo
229   ~yt.frontends.boxlib.io.IOHandlerBoxlib
230   ~yt.frontends.boxlib.io.IOHandlerOrion
231
232Chombo
233^^^^^^
234
235.. autosummary::
236
237   ~yt.frontends.chombo.data_structures.ChomboGrid
238   ~yt.frontends.chombo.data_structures.ChomboHierarchy
239   ~yt.frontends.chombo.data_structures.ChomboDataset
240   ~yt.frontends.chombo.data_structures.Orion2Hierarchy
241   ~yt.frontends.chombo.data_structures.Orion2Dataset
242   ~yt.frontends.chombo.io.IOHandlerChomboHDF5
243   ~yt.frontends.chombo.io.IOHandlerOrion2HDF5
244
245Enzo
246^^^^
247
248.. autosummary::
249
250   ~yt.frontends.enzo.answer_testing_support.ShockTubeTest
251   ~yt.frontends.enzo.data_structures.EnzoGrid
252   ~yt.frontends.enzo.data_structures.EnzoGridGZ
253   ~yt.frontends.enzo.data_structures.EnzoGridInMemory
254   ~yt.frontends.enzo.data_structures.EnzoHierarchy1D
255   ~yt.frontends.enzo.data_structures.EnzoHierarchy2D
256   ~yt.frontends.enzo.data_structures.EnzoHierarchy
257   ~yt.frontends.enzo.data_structures.EnzoHierarchyInMemory
258   ~yt.frontends.enzo.data_structures.EnzoDatasetInMemory
259   ~yt.frontends.enzo.data_structures.EnzoDataset
260   ~yt.frontends.enzo.fields.EnzoFieldInfo
261   ~yt.frontends.enzo.io.IOHandlerInMemory
262   ~yt.frontends.enzo.io.IOHandlerPacked1D
263   ~yt.frontends.enzo.io.IOHandlerPacked2D
264   ~yt.frontends.enzo.io.IOHandlerPackedHDF5
265   ~yt.frontends.enzo.io.IOHandlerPackedHDF5GhostZones
266   ~yt.frontends.enzo.simulation_handling.EnzoCosmology
267   ~yt.frontends.enzo.simulation_handling.EnzoSimulation
268
269FITS
270^^^^
271
272.. autosummary::
273
274   ~yt.frontends.fits.data_structures.FITSGrid
275   ~yt.frontends.fits.data_structures.FITSHierarchy
276   ~yt.frontends.fits.data_structures.FITSDataset
277   ~yt.frontends.fits.fields.FITSFieldInfo
278   ~yt.frontends.fits.io.IOHandlerFITS
279
280FLASH
281^^^^^
282
283.. autosummary::
284
285   ~yt.frontends.flash.data_structures.FLASHGrid
286   ~yt.frontends.flash.data_structures.FLASHHierarchy
287   ~yt.frontends.flash.data_structures.FLASHDataset
288   ~yt.frontends.flash.fields.FLASHFieldInfo
289   ~yt.frontends.flash.io.IOHandlerFLASH
290
291GDF
292^^^
293
294.. autosummary::
295
296   ~yt.frontends.gdf.data_structures.GDFGrid
297   ~yt.frontends.gdf.data_structures.GDFHierarchy
298   ~yt.frontends.gdf.data_structures.GDFDataset
299   ~yt.frontends.gdf.io.IOHandlerGDFHDF5
300
301Halo Catalogs
302^^^^^^^^^^^^^
303
304.. autosummary::
305
306   ~yt.frontends.ahf.data_structures.AHFHalosDataset
307   ~yt.frontends.ahf.fields.AHFHalosFieldInfo
308   ~yt.frontends.ahf.io.IOHandlerAHFHalos
309   ~yt.frontends.gadget_fof.data_structures.GadgetFOFDataset
310   ~yt.frontends.gadget_fof.data_structures.GadgetFOFHDF5File
311   ~yt.frontends.gadget_fof.data_structures.GadgetFOFHaloDataset
312   ~yt.frontends.gadget_fof.io.IOHandlerGadgetFOFHDF5
313   ~yt.frontends.gadget_fof.io.IOHandlerGadgetFOFHaloHDF5
314   ~yt.frontends.gadget_fof.fields.GadgetFOFFieldInfo
315   ~yt.frontends.gadget_fof.fields.GadgetFOFHaloFieldInfo
316   ~yt.frontends.halo_catalog.data_structures.YTHaloCatalogFile
317   ~yt.frontends.halo_catalog.data_structures.YTHaloCatalogDataset
318   ~yt.frontends.halo_catalog.fields.YTHaloCatalogFieldInfo
319   ~yt.frontends.halo_catalog.io.IOHandlerYTHaloCatalog
320   ~yt.frontends.owls_subfind.data_structures.OWLSSubfindParticleIndex
321   ~yt.frontends.owls_subfind.data_structures.OWLSSubfindHDF5File
322   ~yt.frontends.owls_subfind.data_structures.OWLSSubfindDataset
323   ~yt.frontends.owls_subfind.fields.OWLSSubfindFieldInfo
324   ~yt.frontends.owls_subfind.io.IOHandlerOWLSSubfindHDF5
325   ~yt.frontends.rockstar.data_structures.RockstarBinaryFile
326   ~yt.frontends.rockstar.data_structures.RockstarDataset
327   ~yt.frontends.rockstar.fields.RockstarFieldInfo
328   ~yt.frontends.rockstar.io.IOHandlerRockstarBinary
329
330MOAB
331^^^^
332
333.. autosummary::
334
335   ~yt.frontends.moab.data_structures.MoabHex8Hierarchy
336   ~yt.frontends.moab.data_structures.MoabHex8Mesh
337   ~yt.frontends.moab.data_structures.MoabHex8Dataset
338   ~yt.frontends.moab.data_structures.PyneHex8Mesh
339   ~yt.frontends.moab.data_structures.PyneMeshHex8Hierarchy
340   ~yt.frontends.moab.data_structures.PyneMoabHex8Dataset
341   ~yt.frontends.moab.io.IOHandlerMoabH5MHex8
342   ~yt.frontends.moab.io.IOHandlerMoabPyneHex8
343
344OpenPMD
345^^^^^^^
346
347.. autosummary::
348
349   ~yt.frontends.open_pmd.data_structures.OpenPMDGrid
350   ~yt.frontends.open_pmd.data_structures.OpenPMDHierarchy
351   ~yt.frontends.open_pmd.data_structures.OpenPMDDataset
352   ~yt.frontends.open_pmd.fields.OpenPMDFieldInfo
353   ~yt.frontends.open_pmd.io.IOHandlerOpenPMDHDF5
354   ~yt.frontends.open_pmd.misc.parse_unit_dimension
355   ~yt.frontends.open_pmd.misc.is_const_component
356   ~yt.frontends.open_pmd.misc.get_component
357
358RAMSES
359^^^^^^
360
361.. autosummary::
362
363   ~yt.frontends.ramses.data_structures.RAMSESDomainFile
364   ~yt.frontends.ramses.data_structures.RAMSESDomainSubset
365   ~yt.frontends.ramses.data_structures.RAMSESIndex
366   ~yt.frontends.ramses.data_structures.RAMSESDataset
367   ~yt.frontends.ramses.fields.RAMSESFieldInfo
368   ~yt.frontends.ramses.io.IOHandlerRAMSES
369
370SPH and Particle Codes
371^^^^^^^^^^^^^^^^^^^^^^
372
373.. autosummary::
374
375   ~yt.frontends.gadget.data_structures.GadgetBinaryFile
376   ~yt.frontends.gadget.data_structures.GadgetHDF5Dataset
377   ~yt.frontends.gadget.data_structures.GadgetDataset
378   ~yt.frontends.http_stream.data_structures.HTTPParticleFile
379   ~yt.frontends.http_stream.data_structures.HTTPStreamDataset
380   ~yt.frontends.owls.data_structures.OWLSDataset
381   ~yt.frontends.sph.data_structures.ParticleDataset
382   ~yt.frontends.tipsy.data_structures.TipsyFile
383   ~yt.frontends.tipsy.data_structures.TipsyDataset
384   ~yt.frontends.sph.fields.SPHFieldInfo
385   ~yt.frontends.gadget.io.IOHandlerGadgetBinary
386   ~yt.frontends.gadget.io.IOHandlerGadgetHDF5
387   ~yt.frontends.http_stream.io.IOHandlerHTTPStream
388   ~yt.frontends.owls.io.IOHandlerOWLS
389   ~yt.frontends.tipsy.io.IOHandlerTipsyBinary
390
391Stream
392^^^^^^
393
394.. autosummary::
395
396   ~yt.frontends.stream.data_structures.StreamDictFieldHandler
397   ~yt.frontends.stream.data_structures.StreamGrid
398   ~yt.frontends.stream.data_structures.StreamHandler
399   ~yt.frontends.stream.data_structures.StreamHexahedralHierarchy
400   ~yt.frontends.stream.data_structures.StreamHexahedralMesh
401   ~yt.frontends.stream.data_structures.StreamHexahedralDataset
402   ~yt.frontends.stream.data_structures.StreamHierarchy
403   ~yt.frontends.stream.data_structures.StreamOctreeHandler
404   ~yt.frontends.stream.data_structures.StreamOctreeDataset
405   ~yt.frontends.stream.data_structures.StreamOctreeSubset
406   ~yt.frontends.stream.data_structures.StreamParticleFile
407   ~yt.frontends.stream.data_structures.StreamParticleIndex
408   ~yt.frontends.stream.data_structures.StreamParticlesDataset
409   ~yt.frontends.stream.data_structures.StreamDataset
410   ~yt.frontends.stream.fields.StreamFieldInfo
411   ~yt.frontends.stream.io.IOHandlerStream
412   ~yt.frontends.stream.io.IOHandlerStreamHexahedral
413   ~yt.frontends.stream.io.IOHandlerStreamOctree
414   ~yt.frontends.stream.io.StreamParticleIOHandler
415
416ytdata
417^^^^^^
418
419.. autosummary::
420
421   ~yt.frontends.ytdata.data_structures.YTDataContainerDataset
422   ~yt.frontends.ytdata.data_structures.YTSpatialPlotDataset
423   ~yt.frontends.ytdata.data_structures.YTGridDataset
424   ~yt.frontends.ytdata.data_structures.YTGridHierarchy
425   ~yt.frontends.ytdata.data_structures.YTGrid
426   ~yt.frontends.ytdata.data_structures.YTNonspatialDataset
427   ~yt.frontends.ytdata.data_structures.YTNonspatialHierarchy
428   ~yt.frontends.ytdata.data_structures.YTNonspatialGrid
429   ~yt.frontends.ytdata.data_structures.YTProfileDataset
430   ~yt.frontends.ytdata.data_structures.YTClumpTreeDataset
431   ~yt.frontends.ytdata.data_structures.YTClumpContainer
432   ~yt.frontends.ytdata.fields.YTDataContainerFieldInfo
433   ~yt.frontends.ytdata.fields.YTGridFieldInfo
434   ~yt.frontends.ytdata.io.IOHandlerYTDataContainerHDF5
435   ~yt.frontends.ytdata.io.IOHandlerYTGridHDF5
436   ~yt.frontends.ytdata.io.IOHandlerYTSpatialPlotHDF5
437   ~yt.frontends.ytdata.io.IOHandlerYTNonspatialhdf5
438
439Loading Data
440------------
441
442.. autosummary::
443
444   ~yt.loaders.load
445   ~yt.loaders.simulation
446   ~yt.loaders.load_uniform_grid
447   ~yt.loaders.load_amr_grids
448   ~yt.loaders.load_particles
449   ~yt.loaders.load_octree
450   ~yt.loaders.load_hexahedral_mesh
451   ~yt.loaders.load_unstructured_mesh
452   ~yt.loaders.load_sample
453
454Derived Datatypes
455-----------------
456
457Profiles and Histograms
458^^^^^^^^^^^^^^^^^^^^^^^
459
460These types are used to sum data up and either return that sum or return an
461average.  Typically they are more easily used through the ``ProfilePlot``
462``PhasePlot`` interface. We also provide the ``create_profile`` function
463to create these objects in a uniform manner.
464
465
466.. autosummary::
467
468   ~yt.data_objects.profiles.ProfileND
469   ~yt.data_objects.profiles.Profile1D
470   ~yt.data_objects.profiles.Profile2D
471   ~yt.data_objects.profiles.Profile3D
472   ~yt.data_objects.profiles.ParticleProfile
473   ~yt.data_objects.profiles.create_profile
474
475.. _clump_finding_ref:
476
477Clump Finding
478^^^^^^^^^^^^^
479
480The ``Clump`` object and associated functions can be used for identification
481of topologically disconnected structures, i.e., clump finding.
482
483.. autosummary::
484
485   ~yt.data_objects.level_sets.clump_handling.Clump
486   ~yt.data_objects.level_sets.clump_handling.Clump.add_info_item
487   ~yt.data_objects.level_sets.clump_handling.Clump.add_validator
488   ~yt.data_objects.level_sets.clump_handling.Clump.save_as_dataset
489   ~yt.data_objects.level_sets.clump_handling.find_clumps
490   ~yt.data_objects.level_sets.clump_info_items.add_clump_info
491   ~yt.data_objects.level_sets.clump_validators.add_validator
492
493X-ray Emission Fields
494^^^^^^^^^^^^^^^^^^^^^
495
496This can be used to create derived fields of X-ray emission in
497different energy bands.
498
499.. autosummary::
500
501   ~yt.fields.xray_emission_fields.XrayEmissivityIntegrator
502   ~yt.fields.xray_emission_fields.add_xray_emissivity_field
503
504Field Types
505-----------
506
507.. autosummary::
508
509   ~yt.fields.field_info_container.FieldInfoContainer
510   ~yt.fields.derived_field.DerivedField
511   ~yt.fields.derived_field.ValidateDataField
512   ~yt.fields.derived_field.ValidateGridType
513   ~yt.fields.derived_field.ValidateParameter
514   ~yt.fields.derived_field.ValidateProperty
515   ~yt.fields.derived_field.ValidateSpatial
516
517Field Functions
518---------------
519
520.. autosummary::
521
522   ~yt.fields.field_info_container.FieldInfoContainer.add_field
523   ~yt.data_objects.static_output.Dataset.add_field
524   ~yt.data_objects.static_output.Dataset.add_deposited_particle_field
525   ~yt.data_objects.static_output.Dataset.add_mesh_sampling_particle_field
526   ~yt.data_objects.static_output.Dataset.add_smoothed_particle_field
527   ~yt.data_objects.static_output.Dataset.add_gradient_fields
528   ~yt.frontends.stream.data_structures.StreamParticlesDataset.add_sph_fields
529
530Particle Filters
531----------------
532
533.. autosummary::
534
535   ~yt.data_objects.particle_filters.add_particle_filter
536   ~yt.data_objects.particle_filters.particle_filter
537
538Image Handling
539--------------
540
541For volume renderings and fixed resolution buffers the image object returned is
542an ``ImageArray`` object, which has useful functions for image saving and
543writing to bitmaps.
544
545.. autosummary::
546
547   ~yt.data_objects.image_array.ImageArray
548
549Volume Rendering
550^^^^^^^^^^^^^^^^
551
552See also :ref:`volume_rendering`.
553
554Here are the primary entry points and the main classes involved in the
555Scene infrastructure:
556
557.. autosummary::
558
559   ~yt.visualization.volume_rendering.volume_rendering.volume_render
560   ~yt.visualization.volume_rendering.volume_rendering.create_scene
561   ~yt.visualization.volume_rendering.off_axis_projection.off_axis_projection
562   ~yt.visualization.volume_rendering.scene.Scene
563   ~yt.visualization.volume_rendering.camera.Camera
564   ~yt.utilities.amr_kdtree.amr_kdtree.AMRKDTree
565
566The different kinds of sources:
567
568.. autosummary::
569
570   ~yt.visualization.volume_rendering.render_source.RenderSource
571   ~yt.visualization.volume_rendering.render_source.VolumeSource
572   ~yt.visualization.volume_rendering.render_source.PointSource
573   ~yt.visualization.volume_rendering.render_source.LineSource
574   ~yt.visualization.volume_rendering.render_source.BoxSource
575   ~yt.visualization.volume_rendering.render_source.GridSource
576   ~yt.visualization.volume_rendering.render_source.CoordinateVectorSource
577   ~yt.visualization.volume_rendering.render_source.MeshSource
578
579The different kinds of transfer functions:
580
581.. autosummary::
582
583   ~yt.visualization.volume_rendering.transfer_functions.TransferFunction
584   ~yt.visualization.volume_rendering.transfer_functions.ColorTransferFunction
585   ~yt.visualization.volume_rendering.transfer_functions.ProjectionTransferFunction
586   ~yt.visualization.volume_rendering.transfer_functions.PlanckTransferFunction
587   ~yt.visualization.volume_rendering.transfer_functions.MultiVariateTransferFunction
588   ~yt.visualization.volume_rendering.transfer_function_helper.TransferFunctionHelper
589
590The different kinds of lenses:
591
592.. autosummary::
593
594   ~yt.visualization.volume_rendering.lens.Lens
595   ~yt.visualization.volume_rendering.lens.PlaneParallelLens
596   ~yt.visualization.volume_rendering.lens.PerspectiveLens
597   ~yt.visualization.volume_rendering.lens.StereoPerspectiveLens
598   ~yt.visualization.volume_rendering.lens.FisheyeLens
599   ~yt.visualization.volume_rendering.lens.SphericalLens
600   ~yt.visualization.volume_rendering.lens.StereoSphericalLens
601
602Streamlining
603^^^^^^^^^^^^
604
605See also :ref:`streamlines`.
606
607
608.. autosummary::
609
610   ~yt.visualization.streamlines.Streamlines
611
612Image Writing
613^^^^^^^^^^^^^
614
615These functions are all used for fast writing of images directly to disk,
616without calling matplotlib.  This can be very useful for high-cadence outputs
617where colorbars are unnecessary or for volume rendering.
618
619
620.. autosummary::
621
622   ~yt.visualization.image_writer.multi_image_composite
623   ~yt.visualization.image_writer.write_bitmap
624   ~yt.visualization.image_writer.write_projection
625   ~yt.visualization.image_writer.write_image
626   ~yt.visualization.image_writer.map_to_colors
627   ~yt.visualization.image_writer.strip_colormap_data
628   ~yt.visualization.image_writer.splat_points
629   ~yt.visualization.image_writer.scale_image
630
631We also provide a module that is very good for generating EPS figures,
632particularly with complicated layouts.
633
634.. autosummary::
635
636   ~yt.visualization.eps_writer.DualEPS
637   ~yt.visualization.eps_writer.single_plot
638   ~yt.visualization.eps_writer.multiplot
639   ~yt.visualization.eps_writer.multiplot_yt
640   ~yt.visualization.eps_writer.return_cmap
641   ~yt.visualization.eps_writer.return_colormap
642
643.. _derived-quantities-api:
644
645Derived Quantities
646------------------
647
648See :ref:`derived-quantities`.
649
650
651.. autosummary::
652
653   ~yt.data_objects.derived_quantities.DerivedQuantity
654   ~yt.data_objects.derived_quantities.DerivedQuantityCollection
655   ~yt.data_objects.derived_quantities.WeightedAverageQuantity
656   ~yt.data_objects.derived_quantities.AngularMomentumVector
657   ~yt.data_objects.derived_quantities.BulkVelocity
658   ~yt.data_objects.derived_quantities.CenterOfMass
659   ~yt.data_objects.derived_quantities.Extrema
660   ~yt.data_objects.derived_quantities.MaxLocation
661   ~yt.data_objects.derived_quantities.MinLocation
662   ~yt.data_objects.derived_quantities.SpinParameter
663   ~yt.data_objects.derived_quantities.TotalMass
664   ~yt.data_objects.derived_quantities.TotalQuantity
665   ~yt.data_objects.derived_quantities.WeightedAverageQuantity
666   ~yt.data_objects.derived_quantities.WeightedVariance
667
668.. _callback-api:
669
670Callback List
671-------------
672
673
674See also :ref:`callbacks`.
675
676.. autosummary::
677
678   ~yt.visualization.plot_window.PWViewerMPL.annotate_clear
679   ~yt.visualization.plot_window.PWViewerMPL.clear_annotations
680   ~yt.visualization.plot_modifications.ArrowCallback
681   ~yt.visualization.plot_modifications.CellEdgesCallback
682   ~yt.visualization.plot_modifications.ClumpContourCallback
683   ~yt.visualization.plot_modifications.ContourCallback
684   ~yt.visualization.plot_modifications.CuttingQuiverCallback
685   ~yt.visualization.plot_modifications.GridBoundaryCallback
686   ~yt.visualization.plot_modifications.HaloCatalogCallback
687   ~yt.visualization.plot_modifications.ImageLineCallback
688   ~yt.visualization.plot_modifications.LinePlotCallback
689   ~yt.visualization.plot_modifications.MagFieldCallback
690   ~yt.visualization.plot_modifications.MarkerAnnotateCallback
691   ~yt.visualization.plot_modifications.ParticleCallback
692   ~yt.visualization.plot_modifications.PointAnnotateCallback
693   ~yt.visualization.plot_modifications.QuiverCallback
694   ~yt.visualization.plot_modifications.RayCallback
695   ~yt.visualization.plot_modifications.ScaleCallback
696   ~yt.visualization.plot_modifications.SphereCallback
697   ~yt.visualization.plot_modifications.StreamlineCallback
698   ~yt.visualization.plot_modifications.TextLabelCallback
699   ~yt.visualization.plot_modifications.TimestampCallback
700   ~yt.visualization.plot_modifications.TitleCallback
701   ~yt.visualization.plot_modifications.TriangleFacetsCallback
702   ~yt.visualization.plot_modifications.VelocityCallback
703
704Colormap Functions
705------------------
706
707
708See also :ref:`colormaps`.
709
710.. autosummary::
711
712   ~yt.visualization.color_maps.add_cmap
713   ~yt.visualization.color_maps.add_colormap
714   ~yt.visualization.color_maps.make_colormap
715   ~yt.visualization.color_maps.show_colormaps
716
717Function List
718-------------
719
720
721.. autosummary::
722
723   ~yt.frontends.ytdata.utilities.save_as_dataset
724   ~yt.data_objects.data_containers.YTDataContainer.save_as_dataset
725   ~yt.data_objects.static_output.Dataset.all_data
726   ~yt.data_objects.static_output.Dataset.box
727   ~yt.funcs.enable_plugins
728   ~yt.funcs.get_pbar
729   ~yt.funcs.humanize_time
730   ~yt.funcs.insert_ipython
731   ~yt.funcs.is_root
732   ~yt.funcs.is_sequence
733   ~yt.funcs.iter_fields
734   ~yt.funcs.just_one
735   ~yt.funcs.only_on_root
736   ~yt.funcs.paste_traceback
737   ~yt.funcs.pdb_run
738   ~yt.funcs.print_tb
739   ~yt.funcs.rootonly
740   ~yt.funcs.time_execution
741   ~yt.data_objects.level_sets.contour_finder.identify_contours
742   ~yt.utilities.parallel_tools.parallel_analysis_interface.enable_parallelism
743   ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_blocking_call
744   ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_objects
745   ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_passthrough
746   ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_root_only
747   ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_simple_proxy
748   ~yt.data_objects.data_containers.YTDataContainer.get_field_parameter
749   ~yt.data_objects.data_containers.YTDataContainer.set_field_parameter
750
751Math Utilities
752--------------
753
754
755.. autosummary::
756
757   ~yt.utilities.math_utils.periodic_position
758   ~yt.utilities.math_utils.periodic_dist
759   ~yt.utilities.math_utils.euclidean_dist
760   ~yt.utilities.math_utils.rotate_vector_3D
761   ~yt.utilities.math_utils.modify_reference_frame
762   ~yt.utilities.math_utils.compute_rotational_velocity
763   ~yt.utilities.math_utils.compute_parallel_velocity
764   ~yt.utilities.math_utils.compute_radial_velocity
765   ~yt.utilities.math_utils.compute_cylindrical_radius
766   ~yt.utilities.math_utils.ortho_find
767   ~yt.utilities.math_utils.quartiles
768   ~yt.utilities.math_utils.get_rotation_matrix
769   ~yt.utilities.math_utils.get_sph_r
770   ~yt.utilities.math_utils.resize_vector
771   ~yt.utilities.math_utils.get_sph_theta
772   ~yt.utilities.math_utils.get_sph_phi
773   ~yt.utilities.math_utils.get_cyl_r
774   ~yt.utilities.math_utils.get_cyl_z
775   ~yt.utilities.math_utils.get_cyl_theta
776   ~yt.utilities.math_utils.get_cyl_r_component
777   ~yt.utilities.math_utils.get_cyl_theta_component
778   ~yt.utilities.math_utils.get_cyl_z_component
779   ~yt.utilities.math_utils.get_sph_r_component
780   ~yt.utilities.math_utils.get_sph_phi_component
781   ~yt.utilities.math_utils.get_sph_theta_component
782
783
784Miscellaneous Types
785-------------------
786
787
788.. autosummary::
789
790   ~yt.config.YTConfig
791   ~yt.utilities.parameter_file_storage.ParameterFileStore
792   ~yt.utilities.parallel_tools.parallel_analysis_interface.ObjectIterator
793   ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelAnalysisInterface
794   ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelObjectIterator
795
796.. _cosmology-calculator-ref:
797
798Cosmology Calculator
799--------------------
800
801.. autosummary::
802
803   ~yt.utilities.cosmology.Cosmology
804   ~yt.utilities.cosmology.Cosmology.hubble_distance
805   ~yt.utilities.cosmology.Cosmology.comoving_radial_distance
806   ~yt.utilities.cosmology.Cosmology.comoving_transverse_distance
807   ~yt.utilities.cosmology.Cosmology.comoving_volume
808   ~yt.utilities.cosmology.Cosmology.angular_diameter_distance
809   ~yt.utilities.cosmology.Cosmology.angular_scale
810   ~yt.utilities.cosmology.Cosmology.luminosity_distance
811   ~yt.utilities.cosmology.Cosmology.lookback_time
812   ~yt.utilities.cosmology.Cosmology.critical_density
813   ~yt.utilities.cosmology.Cosmology.hubble_parameter
814   ~yt.utilities.cosmology.Cosmology.expansion_factor
815   ~yt.utilities.cosmology.Cosmology.z_from_t
816   ~yt.utilities.cosmology.Cosmology.t_from_z
817   ~yt.utilities.cosmology.Cosmology.get_dark_factor
818
819Testing Infrastructure
820----------------------
821
822The first set of functions are all provided by NumPy.
823
824.. autosummary::
825
826   ~yt.testing.assert_array_equal
827   ~yt.testing.assert_almost_equal
828   ~yt.testing.assert_approx_equal
829   ~yt.testing.assert_array_almost_equal
830   ~yt.testing.assert_equal
831   ~yt.testing.assert_array_less
832   ~yt.testing.assert_string_equal
833   ~yt.testing.assert_array_almost_equal_nulp
834   ~yt.testing.assert_allclose
835   ~yt.testing.assert_raises
836
837These are yt-provided functions:
838
839.. autosummary::
840
841   ~yt.testing.assert_rel_equal
842   ~yt.testing.amrspace
843   ~yt.testing.fake_random_ds
844   ~yt.testing.expand_keywords
845
846These are for the pytest infrastructure:
847
848.. autosummary::
849
850    ~conftest.hashing
851    ~yt.utilities.answer_testing.answer_tests.grid_hierarchy
852    ~yt.utilities.answer_testing.answer_tests.parentage_relationships
853    ~yt.utilities.answer_testing.answer_tests.grid_values
854    ~yt.utilities.answer_testing.answer_tests.projection_values
855    ~yt.utilities.answer_testing.answer_tests.field_values
856    ~yt.utilities.answer_testing.answer_tests.pixelized_projection_values
857    ~yt.utilities.answer_testing.answer_tests.small_patch_amr
858    ~yt.utilities.answer_testing.answer_tests.big_patch_amr
859    ~yt.utilities.answer_testing.answer_tests.generic_array
860    ~yt.utilities.answer_testing.answer_tests.sph_answer
861    ~yt.utilities.answer_testing.answer_tests.get_field_size_and_mean
862    ~yt.utilities.answer_testing.answer_tests.plot_window_attribute
863    ~yt.utilities.answer_testing.answer_tests.phase_plot_attribute
864    ~yt.utilities.answer_testing.answer_tests.generic_image
865    ~yt.utilities.answer_testing.answer_tests.axial_pixelization
866    ~yt.utilities.answer_testing.answer_tests.extract_connected_sets
867    ~yt.utilities.answer_testing.answer_tests.VR_image_comparison
868