hyperspy.docstrings.signal module

Common docstring snippets for signal.

hyperspy.docstrings.signal.MANY_AXIS_PARAMETER = ': int, str, `axis`, tuple of `axis` or None\n Either one on its own, or many axes in a tuple can be passed. In\n both cases the axes can be passed directly, or specified using the\n index in `axes_manager` or the name of the axis. Any duplicates are\n removed. If None, the operation is performed over all navigation\n axes (default).'

hyperspy.docstrings.signal.NAN_FUNC = 'Identical to {0} except ignores missing (NaN) values.\n The full documentation follows:\n\n -------------------- {0} --------------------\n {1} '

hyperspy.docstrings.signal.ONE_AXIS_PARAMETER = ': int, str or `axis`\n The axis can be passed directly, or specified using the index of\n the axis in `axes_manager` or the axis name.'

hyperspy.docstrings.signal.OPTIMIZE_ARG = 'optimize : bool\n If True, the location of the data in memory is optimised for the\n fastest iteration over the navigation axes. This operation can\n cause a peak of memory usage and requires considerable processing\n times for large datasets and/or low specification hardware.\n See the `transposing` section of the HyperSpy user guide\n for more information. When operating on lazy signals, if `True`\n the chunks are optimised for the new axes configuration.'

hyperspy.docstrings.signal.OUT_ARG = 'out : `Signal` or None\n If None, a new Signal is created with the result of the operation\n and returned (default). If a Signal is passed, it is used to\n receive the output of the operation, and nothing is returned.'

hyperspy.docstrings.signal.PARALLEL_ARG = 'parallel : None or bool\n If True, perform computation in parallel using multiple cores. If \n None the default from the preferences settings is used.'

hyperspy.docstrings.signal.PARALLEL_INT_ARG = 'parallel : None, bool or int\n If True, perform computation in parallel using multiple cores. If \n int, use as many cores as specified. If None the default from \n the preferences settings is used.'

hyperspy.docstrings.signal.RECHUNK_ARG = 'rechunk: bool\n Only has effect when operating on lazy signal. If `True` (default),\n the data may be automatically rechunked before performing this operation.'

hyperspy.docstrings.signal.SHOW_PROGRESSBAR_ARG = 'show_progressbar : None or bool\n If True, display a progress bar. If None the default from the \n preferences settings is used.'