cathy package#
Submodules#
cathy.art module#
cathy.cli module#
Command Line Interface for cathy.
- class cathy.cli.ChoiceOrInts(choices)#
Bases:
Ints
- convert(value, param, ctx)#
Convert the value to the correct type. This is not called if the value is
None
(the missing value).This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.
The
param
andctx
arguments may beNone
in certain situations, such as when converting prompt input.If the value cannot be converted, call
fail()
with a descriptive message.- Parameters:
value – The value to convert.
param – The parameter that is using this type to convert its value. May be
None
.ctx – The current context that arrived at this value. May be
None
.
- property name#
str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
- class cathy.cli.ExistingDirectory(*args, **kwargs)#
Bases:
Path
A click.Path with customized default args.
- class cathy.cli.Ints#
Bases:
ParamType
Options strings will be an equals sign followed by one or more non-negative integers, separated by commas and dashes. Dashes indicate ranges (e.g., “1-3” -> [1, 2, 3]), and commas separate values and ranges.
- convert(value, param, ctx)#
Convert the value to the correct type. This is not called if the value is
None
(the missing value).This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.
The
param
andctx
arguments may beNone
in certain situations, such as when converting prompt input.If the value cannot be converted, call
fail()
with a descriptive message.- Parameters:
value – The value to convert.
param – The parameter that is using this type to convert its value. May be
None
.ctx – The current context that arrived at this value. May be
None
.
- name: str = 'INTs'#
the descriptive name of this type
- cathy.cli.addGrid(axes)#
Add major and minor gridlines to the given plot
- cathy.cli.run_localize(src_path, dst_path, distal_index=5, proximal_index=4, geometry_index=1, dither_index=0, algos=[], output_iterations=False, tol=1e-06, max_iterations=32)#