Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BF: If n_frames is larger than one use path-numbering. #659

Merged
merged 3 commits into from
Jun 4, 2015
Merged

BF: If n_frames is larger than one use path-numbering. #659

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d39c0f
BF: If n_frames is larger than one use path-numbering.
arokem Jun 3, 2015
7cf9821
DOC: Fix typos/caps/defaults in docstring of `viz.fvtk.record`.
arokem Jun 4, 2015
fd627ad
DOC: The default values of some things are mysterious and ephemeral.
arokem Jun 4, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions dipy/viz/fvtk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1753,29 +1753,30 @@ def record(ren=None, cam_pos=None, cam_focal=None, cam_view=None,
magnification=1, size=(300, 300), verbose=False):
''' This will record a video of your scene

Records a video as a series of ``.png`` files of your scene by rotating the
azimuth angle az_angle in every frame.
Records a video as a series of ``.png`` files of your scene by rotating
the azimuth angle az_angle in every frame.

Parameters
-----------
ren : vtkRenderer() object
as returned from function ren()
As returned from :func:`ren`.
cam_pos : None or sequence (3,), optional
camera position
Camera position
cam_focal : None or sequence (3,), optional
camera focal point
Camera focal point
cam_view : None or sequence (3,), optional
camera view up
Camera view up. Default
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default is

out_path : str, optional
output directory for the frames
path_numbering : bool
when recording it changes out_path ot out_path + str(frame number)
Output directory for the frames
path_numbering : bool, optional
when recording it changes out_path to out_path + str(frame number).
If n_frames is larger than 1, this will default to True
n_frames : int, optional
number of frames to save, default 1
number of frames to save. Default: 1
az_ang : float, optional
azimuthal angle of camera rotation.
Azimuthal angle of camera rotation (degrees). Default: 10.
magnification : int, optional
how much to magnify the saved frame
How much to magnify the saved frame. Default: 1 (no magnification).

Examples
---------
Expand Down Expand Up @@ -1832,7 +1833,7 @@ def record(ren=None, cam_pos=None, cam_focal=None, cam_view=None,
renderLarge.Update()
writer.SetInputConnection(renderLarge.GetOutputPort())
# filename='/tmp/'+str(3000000+i)+'.png'
if path_numbering:
if n_frames > 1 or path_numbering:
if out_path is None:
filename = str(1000000 + i) + '.png'
else:
Expand Down