Skip to content

Commit

Permalink
modifying help text in the CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
behrouzvia committed Feb 27, 2024
1 parent 62116ae commit a587513
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
3 changes: 2 additions & 1 deletion shimmingtoolbox/cli/b0shim.py
Expand Up @@ -72,7 +72,8 @@ def b0shim_cli():
"it will be: {0,2,4}, {1,3,5}, etc.")
@click.option('--optimizer-method', 'method', required=False, default='quad_prog', show_default=True,
type=click.Choice(['least_squares', 'pseudo_inverse', 'quad_prog', 'gradient']),
help="Method used by the optimizer. LS, QP and gradient will respect the constraints,"
help="Method used by the optimizer. LS, QP will respect the constraints, "
"gradient method only accepts bounds for each channel "
"PS will not respect the constraints")
@click.option('--regularization-factor', 'reg_factor', type=click.FLOAT, required=False, default=0.0, show_default=True,
help="Regularization factor for the current when optimizing. A higher coefficient will penalize higher "
Expand Down
3 changes: 1 addition & 2 deletions shimmingtoolbox/optimizer/gradient_optimizer.py
Expand Up @@ -11,8 +11,7 @@
class GradientOpt(LsqOptimizer):
""" Optimizer object that stores coil profiles and optimizes an unshimmed volume given a mask.
Use optimize (args) to optimize a given mask. The algorithm uses a gradient based solver (L-BFGS-B)
to find the best shim. It supports bounds for each channel as well as a bound for the absolute sum
of the channels.
to find the best shim. It supports bounds for each shim channel.
"""

def __init__(self, coils: List, unshimmed, affine, opt_criteria='mse', initial_guess_method='mean',
Expand Down

0 comments on commit a587513

Please sign in to comment.