Download

Classes:

Name	Description
FoldernameCallback	Store the folder name from the scp.handle_store callback
RetrieveProgress	Pass progress from scp.handle_store callback to RichProgressObject.

Functions:

Name	Description
from_accession_number	Download all series from accession number.
from_search	Download all series specified by search terms.
from_study_uid_list	Download all series from accession number.

FoldernameCallback

FoldernameCallback()

Store the folder name from the scp.handle_store callback

Methods:

Name	Description
filename_callback	Store the filename

filename_callback

filename_callback(folder: Path) -> None

Store the filename

RetrieveProgress

RetrieveProgress(progress: RichProgressObject)

Pass progress from scp.handle_store callback to RichProgressObject.

Methods:

Name	Description
progress	progress callback

progress

progress(result: RetrieveResult) -> None

progress callback

from_accession_number

from_accession_number(
    accession_number: str,
    modalities: Sequence[str] | None,
    retrieve_callback: Callable[[RetrieveResult], None],
    settings: PacsConfig,
    sop_class_uid: Iterable[str] | None,
    verbose: bool,
) -> list[SeriesData]

Download all series from accession number.

Parameters:

Name	Type	Description	Default
accession_number	str	the accession number to process.	required
modalities	Sequence[str] | None	optional list of modalities to filter series by.	required
retrieve_callback	Callable[[RetrieveResult], None]	progress callback.	required
settings	PacsConfig	settings	required
sop_class_uid	Iterable[str] | None	optional list of SOPClassUIDs to filter series by.	required
verbose	bool	more debugging.	required

Returns:

Type	Description
list[SeriesData]	list of downloaded series.

from_search

from_search(
    search_terms: SearchTerms,
    anonymizer: Anonymizer,
    folder_callback: Callable[[Path], None],
    dumpdir: Path | None,
    sop_class_uid: Iterable[str] | None = None,
) -> list[SeriesData]

Download all series specified by search terms.

Parameters:

Name	Type	Description	Default
search_terms	SearchTerms	the search terms to process.	required
anonymizer	Anonymizer	Anonymizer to anonymize the dataset.	required
folder_callback	Callable[[Path], None]	Callback function for returning the final path.	required
dumpdir	Path | None	optional list of SOPClassUIDs to filter series by.	required
sop_class_uid	Iterable[str] | None	optional alternative output directory. if not provided, use default specified in the settings.	None

Returns:

Type	Description
list[SeriesData]	list of series

from_study_uid_list

from_study_uid_list(
    study_uids: Sequence[str],
    output_filename: Path | None,
    modalities: Sequence[str] | None,
    sop_class_uid: Iterable[str] | None,
    settings: PacsConfig,
) -> None

Download all series from accession number.

Parameters:

Name	Type	Description	Default
study_uids	Sequence[str]	the study UIDs to process.	required
output_filename	Path | None	CVS output of downloaded series.	required
modalities	Sequence[str] | None	optional list of modalities to filter series by.	required
sop_class_uid	Iterable[str] | None	ptional list of SOPClassUIDs to filter series by.	required
settings	PacsConfig	settings	required

Returns:

Type	Description
None	None