Sam Skillman avatar Sam Skillman committed 0a1f027

Adding some docs

Comments (0)

Files changed (1)

yt/visualization/volume_rendering/camera.py

         clip_ratio : float, optional
             If supplied, the 'max_val' argument to write_bitmap will be handed
             clip_ratio * image.std()
+        double_check : bool, optional
+            Optionally makes sure that the data contains only valid entries.
+            Used for debugging.
+        num_threads : int, optional
+            If supplied, will use 'num_threads' number of OpenMP threads during
+            the rendering.  Defaults to 0, which uses the environment variable
+            OMP_NUM_THREADS.
 
         Returns
         -------
         self.save_image(fn, clim, image)
 
         return image
+
     def save_image(self, fn, clim, image):
         if self.comm.rank is 0 and fn is not None:
             # This assumes Density; this is a relatively safe assumption.
         sampler = self.get_sampler(args)
 
         self.initialize_source()
-        
+
         image = self._render(double_check, num_threads, image, sampler)
 
         self.save_image(fn, clip_ratio, image)
 
         return image
+    snapshot.__doc__ = Camera.snapshot.__doc__
 
 data_object_registry["projection_camera"] = ProjectionCamera
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.