nbiatoolkit.nbia_cli

Module Contents

Functions

version()

_initialize_parser(→ argparse.ArgumentParser)

_add_extra_args(→ argparse.Namespace)

getResults_cli(→ None)

Executes the given function with the provided keyword arguments and prints the results.

writeResultsToFile(→ None)

Writes the results of a query to a file.

cli_wrapper(→ List[str] | None)

Wraps a function call with a loading animation.

getPatients_cli(→ None)

getCollections_cli(→ None)

getNewPatients_cli(→ None)

getBodyPartCounts_cli(→ None)

getStudies_cli(→ None)

getSeries_cli(→ None)

getNewSeries_cli(→ None)

downloadSingleSeries_cli(→ None)

DICOMSorter_cli()

Attributes

done_event

query

output

nbiatoolkit.nbia_cli.done_event
nbiatoolkit.nbia_cli.query: str
nbiatoolkit.nbia_cli.output: io.TextIOWrapper | None
nbiatoolkit.nbia_cli.version()[source]
nbiatoolkit.nbia_cli._initialize_parser(description: str) argparse.ArgumentParser[source]
nbiatoolkit.nbia_cli._add_extra_args(parser: argparse.ArgumentParser) argparse.Namespace[source]
nbiatoolkit.nbia_cli.getResults_cli(func, **kwargs) None[source]

Executes the given function with the provided keyword arguments and prints the results.

Parameters:
  • func – The function to be executed.

  • **kwargs – Keyword arguments to be passed to the function.

Returns:

None

nbiatoolkit.nbia_cli.writeResultsToFile(results: List, output: io.TextIOWrapper) None[source]

Writes the results of a query to a file.

Parameters:
  • results – The results of the query.

  • output – The path to the output file.

Returns:

None

nbiatoolkit.nbia_cli.cli_wrapper(func, **kwargs) List[str] | None[source]

Wraps a function call with a loading animation.

Parameters:
  • func – The function to be called.

  • **kwargs – Keyword arguments to be passed to the function.

Returns:

The result of the function call.

nbiatoolkit.nbia_cli.getPatients_cli() None[source]
nbiatoolkit.nbia_cli.getCollections_cli() None[source]
nbiatoolkit.nbia_cli.getNewPatients_cli() None[source]
nbiatoolkit.nbia_cli.getBodyPartCounts_cli() None[source]
nbiatoolkit.nbia_cli.getStudies_cli() None[source]
nbiatoolkit.nbia_cli.getSeries_cli() None[source]
nbiatoolkit.nbia_cli.getNewSeries_cli() None[source]
nbiatoolkit.nbia_cli.downloadSingleSeries_cli() None[source]
nbiatoolkit.nbia_cli.DICOMSorter_cli()[source]