Final Documentation Pull Request #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
Co-authored-by: Pierre-Antoine Comby <[email protected]>
Comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]>
comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]>
comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]>
comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]>
comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]>
comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]>
Minor typo Co-authored-by: Pierre-Antoine Comby <[email protected]>
Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]>
Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]>
Doc fourier
Codecov Report
@@ Coverage Diff @@
## develop #155 +/- ##
==========================================
Coverage ? 82.34%
==========================================
Files ? 47
Lines ? 2294
Branches ? 0
==========================================
Hits ? 1889
Misses ? 405
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
chaithyagr
added a commit
that referenced
this pull request
Jan 5, 2024
* documentation reconstructors * Revised the documentation on non-uniform Fourier operators * Clean documentation on gradient operators * Update mri/operators/fourier/cartesian.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py Comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor typo Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Apply suggestions from code review Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * [doc] s/: np\./: numpy\./g * [doc] s/""" /"""/g * [doc][fourier] Constructor parameters in class docstring * [doc] s/: ndarray/: numpy.ndarray/g --------- Co-authored-by: Zaineb AMOR <[email protected]> Co-authored-by: Philippe Ciuciu <[email protected]> Co-authored-by: Guillaume DAVAL FREROT <[email protected]> Co-authored-by: Pierre-Antoine Comby <[email protected]> Co-authored-by: Daval-G <[email protected]> Co-authored-by: Pierre-antoine Comby <[email protected]>
chaithyagr
added a commit
that referenced
this pull request
Jan 19, 2024
* revised documentation of Cartesian Fourier operators * run isort to optimize imports * Base operator docstring * Use f-string and clean code * rename coefs to coeffs * format docstrings * [typo] Use american learned. * add dtype option for gradient. * [test] add pydocstyle to CI * Use FourierOperatorBase class. * use the uses_sense property * single Channel reconstruction can also be used for SENSE. * add shape and n_coils * fix import * last check function removing * add docstring * uses sense check for Gradient operator. * cleanup doc and add ref * cast to builtin int Make the condition pass if `n_coil` is a custom integer type (eg np.int64) * inherit from OperatorBase * remove redundant declaration of op/adj_op method. * pass extra gradient args to parentclass. This allow to setup deeper parameters, such as input_data_writeable. * add auto threshold operator. * fix deprecated dtype (error with numpy 1.24) * fix bugs. * add auto sure example. * rework of the eestimation function. * cleaning. * remove level-shared method. * add thresh range argument. * someone left a bug here. * refactor: externalize the computation of wavelet threshold. * improve docstrings. * use elif blocks. * s/level/scale/g * improve auto-threshold example. * update docstring parameters. * add import in init modules. * Cartesian-> cartesian * coeffs_shape * Fix typo * feat: update the example for auto_threshold. * Final Documentation Pull Request #155 (#158) * documentation reconstructors * Revised the documentation on non-uniform Fourier operators * Clean documentation on gradient operators * Update mri/operators/fourier/cartesian.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py Comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor typo Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Apply suggestions from code review Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * [doc] s/: np\./: numpy\./g * [doc] s/""" /"""/g * [doc][fourier] Constructor parameters in class docstring * [doc] s/: ndarray/: numpy.ndarray/g --------- Co-authored-by: Zaineb AMOR <[email protected]> Co-authored-by: Philippe Ciuciu <[email protected]> Co-authored-by: Guillaume DAVAL FREROT <[email protected]> Co-authored-by: Pierre-Antoine Comby <[email protected]> Co-authored-by: Daval-G <[email protected]> Co-authored-by: Pierre-antoine Comby <[email protected]> * Update versioning * Updated codes * Fix one example * Cartesian recon * Fix Density comp * Added density compensation and gpunufft stuff * refactored all examples * Fix GL * Update setup.py * Update setup.py * Update setup.py * Fix density compensation comparison module * Added density compensation module * Create gpu_requirements * Rename gpu_requirements to gpu_requirements.txt * Update README.txt * Update gpu_requirements.txt * Update gpu_requirements.txt * Update setup.py * Added auto tuto * Final large iteration * Move back to GPU for speed * Minor bug fix * Checking done * fix versioning * remove * Fix auto thresh * Fix grid search * Update modopt --------- Co-authored-by: Philippe Ciuciu <[email protected]> Co-authored-by: Pierre-antoine Comby <[email protected]> Co-authored-by: Pierre-Antoine Comby <[email protected]> Co-authored-by: Daval-G <[email protected]> Co-authored-by: Zaineb AMOR <[email protected]> Co-authored-by: Guillaume DAVAL FREROT <[email protected]> Co-authored-by: GILIYAR RADHAKRISHNA Chaithya <[email protected]>
chaithyagr
added a commit
that referenced
this pull request
Jan 19, 2024
* revised documentation of Cartesian Fourier operators * run isort to optimize imports * Base operator docstring * Use f-string and clean code * rename coefs to coeffs * format docstrings * [typo] Use american learned. * add dtype option for gradient. * [test] add pydocstyle to CI * Use FourierOperatorBase class. * use the uses_sense property * single Channel reconstruction can also be used for SENSE. * add shape and n_coils * fix import * last check function removing * add docstring * uses sense check for Gradient operator. * cleanup doc and add ref * cast to builtin int Make the condition pass if `n_coil` is a custom integer type (eg np.int64) * inherit from OperatorBase * remove redundant declaration of op/adj_op method. * pass extra gradient args to parentclass. This allow to setup deeper parameters, such as input_data_writeable. * add auto threshold operator. * fix deprecated dtype (error with numpy 1.24) * fix bugs. * add auto sure example. * rework of the eestimation function. * cleaning. * remove level-shared method. * add thresh range argument. * someone left a bug here. * refactor: externalize the computation of wavelet threshold. * improve docstrings. * use elif blocks. * s/level/scale/g * improve auto-threshold example. * update docstring parameters. * add import in init modules. * Cartesian-> cartesian * coeffs_shape * Fix typo * feat: update the example for auto_threshold. * Final Documentation Pull Request #155 (#158) * documentation reconstructors * Revised the documentation on non-uniform Fourier operators * Clean documentation on gradient operators * Update mri/operators/fourier/cartesian.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py Comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py comply to the pydocstyle guidelines Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor typo Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/cartesian.py Minor fix Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/operators/fourier/non_cartesian.py * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * Apply suggestions from code review Co-authored-by: Pierre-Antoine Comby <[email protected]> * Update mri/reconstructors/base.py Co-authored-by: Pierre-Antoine Comby <[email protected]> * [doc] s/: np\./: numpy\./g * [doc] s/""" /"""/g * [doc][fourier] Constructor parameters in class docstring * [doc] s/: ndarray/: numpy.ndarray/g --------- Co-authored-by: Zaineb AMOR <[email protected]> Co-authored-by: Philippe Ciuciu <[email protected]> Co-authored-by: Guillaume DAVAL FREROT <[email protected]> Co-authored-by: Pierre-Antoine Comby <[email protected]> Co-authored-by: Daval-G <[email protected]> Co-authored-by: Pierre-antoine Comby <[email protected]> * Update versioning * Updated codes * Fix one example * Cartesian recon * Fix Density comp * Added density compensation and gpunufft stuff * refactored all examples * Fix GL * Update setup.py * Update setup.py * Update setup.py * Fix density compensation comparison module * Added density compensation module * Create gpu_requirements * Rename gpu_requirements to gpu_requirements.txt * Update README.txt * Update gpu_requirements.txt * Update gpu_requirements.txt * Update setup.py * Added auto tuto * Final large iteration * Move back to GPU for speed * Minor bug fix * Checking done * fix versioning * remove * Fix auto thresh * Fix grid search * Update modopt --------- Co-authored-by: Philippe Ciuciu <[email protected]> Co-authored-by: Pierre-antoine Comby <[email protected]> Co-authored-by: Pierre-Antoine Comby <[email protected]> Co-authored-by: Daval-G <[email protected]> Co-authored-by: Zaineb AMOR <[email protected]> Co-authored-by: Guillaume DAVAL FREROT <[email protected]> Co-authored-by: GILIYAR RADHAKRISHNA Chaithya <[email protected]>
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.
This the final documentation improvement PR.
All documentation improvement should start from the
documentationbranch, and target it in their PR.When everything will be correct for the documentation, we will merge this into
develop.