WIP: adapt Brain.save_movie() API for imageio #155
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Codec to use with ffmpeg (default 'mpeg4'). | ||
| bitrate : str | float | ||
| Bitrate to use to encode movie. Can be specified as number (e.g. | ||
| 64000) or string (e.g. '64k'). Default value is 1M |
There was a problem hiding this comment.
add kwargs to the docstring
christianbrodbeck
force-pushed
the
imageio
branch
from
1fc180b
to
fb5c56d
Compare
|
Updated. Keeping the specific keywords open would have the big advantage that additional imageio formats would become available, such as *.gif |
| bitrate : str | float | ||
| Bitrate to use to encode movie. Can be specified as number (e.g. | ||
| 64000) or string (e.g. '64k'). Default value is 1M | ||
| additional keywords : |
There was a problem hiding this comment.
why additional keywords and not **kwargs :
There was a problem hiding this comment.
fine with me :)
|
ready to merge? |
|
If you're happy with the documentation |
|
ok next time set the PR to MRG so I don't have to ask :) |
|
Ok, sorry :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following up on #154
imageioparameters: http://imageio.readthedocs.io/en/latest/format_ffmpeg.html#parameters-for-savingProbably the most sense would make to provide access to all of
imageio's options. I've saved a couple of movies andimageioseems to have sensible defaults (variable bitrate, hence I removed our fixed bitrate default). We could keep the existing keyword arguments so we don't break code that used positional arguments. Are there better alternatives? I am not sure how to document in case we just include a**kwargsin the signature. Should the documentation just include a link toimageio's documentation?