neuralib.scanbox.view.ScanBoxViewOptions

class neuralib.scanbox.view.ScanBoxViewOptions

Bases: AbstractParser

__init__()

Methods

__init__()
main([args, parse_only, system_exit])	parsing the commandline input args and call run().
new_parser(**kwargs)	create an ArgumentParser.
run()	called after main().

Attributes

DESCRIPTION	parser description.
EPILOG	parser epilog.
USAGE	parser usage.
channel	which pmt channel (default: 0)
directory	directory containing .sbx/.mat scanbox output
frames	indices of image sequences, if None, then all frames (default: None)
plane	which optic plane (default: 0)
show	play the selected imaging sequences (default: False)
to_tiff	save sequence as tiff output (default: None)
verbose	show meta verbose (default: False)

DESCRIPTION: str | None = 'ScanBox data view & save options'

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

directory: Path

directory containing .sbx/.mat scanbox output

frames: tuple[int, int] | None

indices of image sequences, if None, then all frames (default: None)

plane: int

which optic plane (default: 0)

channel: int

which pmt channel (default: 0)

verbose: bool

show meta verbose (default: False)

show: bool

play the selected imaging sequences (default: False)

to_tiff: Path | None

save sequence as tiff output (default: None)

run()

called after main(). Used for runs the main execution logic of the object