added docs for --input_axes #131
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
also reordered the sections a bit, with the new section Input Settings. fixes #117
|
I had a feeling that was missing from the docs. Awesome! Do you think we should also specify that that is the C-order of the axes, as represented in memory? |
Tomaz-Vieira
reviewed
May 6, 2020
| @@ -63,7 +63,10 @@ CPU and RAM resources can be controlled with environment variables or a config f | |||
| **Optional input settings:** | |||
|
|
|||
| - `--readonly` Open the project in read-only mode; necessary for using a single project from multiple processes. | |||
| - `--input_axes` specify meaning of your axes. In some cases ilastik's default guess for the axes is not correct. In such cases, supply the axes explicitly (e.g. `--input_axes=zcyx` for a 3D dataset with channels and the axes in the "zcyx" order). | |||
| - `--input_axes` specify meaning of your axes. In some cases ilastik's default guess for the axes is not correct. | |||
| In such cases, supply the axes explicitly (e.g. `--input_axes=zcyx` for a 3D dataset with channels and the axes in the "zcyx" order). | |||
There was a problem hiding this comment.
Maybe we should mention that for stack inputs, --input-axes refers to the axis order of each slice in the stack?
Tomaz-Vieira
approved these changes
Dec 10, 2020
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.
--input_axesparameter was undocumented.also reordered the sections a bit, with the new section Input Settings.
fixes #117