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.

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

updates to README.md #50

Closed
neuronflow opened this issue Mar 28, 2024 · 3 comments · Fixed by #51
Closed

updates to README.md #50

neuronflow opened this issue Mar 28, 2024 · 3 comments · Fixed by #51
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@neuronflow
Copy link
Contributor

We need:

  • a short general description, what ereg is, what it can do and why it exists.
  • the documentation needs to show how to modify/structure the configuration file
  • the documentation needs to show how to transform images based on the derived registration matrixes.
@sarthakpati
Copy link
Collaborator

sarthakpati commented Mar 28, 2024

the documentation needs to show how to transform images based on the derived registration matrixes.

This is handled by the transform_file, and I have put this information in the main README:

image

Specifically, the wording reads: the transform file to save the transform to; if already present, will use this transform instead of computing a new one

@neuronflow
Copy link
Contributor Author

Should we provide a register and a transform function/method to be more in line with other registration packages?

@neuronflow neuronflow added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 28, 2024
@sarthakpati
Copy link
Collaborator

Should we provide a register and a transform function/method to be more in line with other registration packages?

We already have that in the OO interface:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants