neuralib.imaging.widefield.fft_view.WideFieldFFTViewOption

class neuralib.imaging.widefield.fft_view.WideFieldFFTViewOption

Bases: AbstractParser

__init__()

Methods

__init__()
main([args, exit_on_error])	parsing the commandline input args and set the argument attributes, then call run().
new_parser(**kwargs)	create an argparse.ArgumentParser.
post_parsing()	called when all argument attributes are set but before run().
run()	called when all argument attributes are set

Attributes

DESCRIPTION	parser description.
EPILOG	parser epilog.
USAGE	parser usage.
file	file path for the video sequence

DESCRIPTION: str = 'View the HSV colormap representation of the Fourier transform results'

parser description.

EPILOG: str = None

parser epilog. Could be override as a method if its content is dynamic-generated.

USAGE: str = None

parser usage.

static __new__(cls, *args, **kwargs)

file: str

file path for the video sequence

main(args=None, *, exit_on_error=True)

parsing the commandline input args and set the argument attributes, then call run().

Example

if overwrite with the argument default, use args

>>> AbstractParser().main((['--source=allen_mouse_25um', '--region=VISal,VISam,...'], []))

Parameters:

• args (list[str] | tuple[list[str]] | None) – commandline arguments, or a tuple of (prepend, append) arguments

• exit_on_error (bool) – exit when commandline parsed fail. Otherwise, raise a RuntimeError.

classmethod new_parser(**kwargs)

create an argparse.ArgumentParser.

class variable: USAGE, DESCRIPTION and EPILOG are used when creation.

>>> class A(AbstractParser):
...     @classmethod
...     def new_parser(cls, **kwargs) -> argparse.ArgumentParser:
...         return super().new_parser(**kwargs)

Parameters:

kwargs – keyword parameters to ArgumentParser

Returns:

an ArgumentParser.

Return type:

ArgumentParser

post_parsing()

called when all argument attributes are set but before run().

It is used for a common operation for a common option class, for example, checking arguments before doing things.

run()

called when all argument attributes are set