Retrieve¶

retrieve¶

Classes:

Name	Description
`RetrievePacs`	Protocol describing RetrievePacs.

Functions:

Name	Description
`get_retrieve`	factory method to create RetrievePacs based on the transfer_method specified in pacs_config.

RetrievePacs ¶

Bases: Protocol

Protocol describing RetrievePacs.

Methods:

Name	Description
`retrieve`	Retrieve images for a dataset.
`retrieve_images_for_a_series`	Retrieve images for a series.

retrieve ¶

retrieve(dataset: Dataset) -> RetrieveResult | None

Retrieve images for a dataset.

retrieve_images_for_a_series ¶

retrieve_images_for_a_series(
    series_data: SeriesData,
) -> None

Retrieve images for a series.

get_retrieve ¶

get_retrieve(
    pacs_config: PacsConfig,
    uid_mapping: Callable[[str], str],
    folder_callback: Callable[
        [Path], None
    ] = dummy_filename_callback,
    retrieve_callback: Callable[
        [RetrieveResult], None
    ] = dummy_retrieve_progress,
    anonymizer: Anonymizer = dummy_anonymize,
    sop_class_uid: Iterable[str] | None = None,
    store_scp: bool = True,
) -> RetrievePacs

factory method to create RetrievePacs based on the transfer_method specified in pacs_config.

retrieve_c_get¶

Perform C_GET action.

Classes:

Name	Description
`RetrievePacsGet`	Retrieve images from PACS using C-GET.

RetrievePacsGet ¶

RetrievePacsGet(
    pacs_config: PacsConfig,
    uid_mapping: Callable[[str], str],
    folder_callback: Callable[[Path], None],
    retrieve_callback: Callable[[RetrieveResult], None],
    anonymizer: Anonymizer = dummy_anonymize,
    sop_class_uid: Iterable[str] | None = None,
)

Retrieve images from PACS using C-GET. Based on getscu.py

Methods:

Name	Description
`retrieve`	Retrieve images for a dataset.
`retrieve_images_for_a_series`	Retrieve images for a series.

retrieve ¶

retrieve(dataset: Dataset) -> RetrieveResult | None

Retrieve images for a dataset.

retrieve_images_for_a_series ¶

retrieve_images_for_a_series(
    series_data: SeriesData,
) -> None

Retrieve images for a series.

retrieve_c_move¶

Perform C_MOVE action.

Classes:

Name	Description
`RetrievePacsMove`	Retrieve images from PACS using C-MOVE.

RetrievePacsMove ¶

RetrievePacsMove(
    pacs_config: PacsConfig,
    uid_mapping: Callable[[str], str],
    retrieve_callback: Callable[[RetrieveResult], None],
    folder_callback: Callable[[Path], None],
    anonymizer: Anonymizer = dummy_anonymize,
    sop_class_uid: Iterable[str] | None = None,
    store_scp: bool = True,
)

Retrieve images from PACS using C-MOVE. Based on movescu.py

Methods:

Name	Description
`retrieve`	Retrieve images for a dataset.
`retrieve_images_for_a_series`	Retrieve images for a series.

retrieve ¶

retrieve(dataset: Dataset) -> RetrieveResult | None

Retrieve images for a dataset.

retrieve_images_for_a_series ¶

retrieve_images_for_a_series(
    series_data: SeriesData,
) -> None

Retrieve images for a series.

retrieve_utils¶

Utilities used by the RetrievePacs classes.

Classes:

Name	Description
`AssociationError`	Exception raised when an association operation fails.
`DicomStatus`	DICOM C-MOVE status codes
`RetrieveError`	Exception raised when a retrieve operation fails.
`RetrieveResult`	The result of a retrieve operation.

Functions:

Name	Description
`process_responses`	Process the retrieve responses.

AssociationError ¶

Bases: Exception

Exception raised when an association operation fails.

DicomStatus ¶

Bases: Enum

DICOM C-MOVE status codes

Attributes:

Name	Type	Description
`CANCEL`		Cancel.
`DATASET_DOESNT_MATCH_SOP_CLASS`		Data Set does not match SOP Class.
`FAILED_UNABLE_TO_PROCESS`		Unable to process.
`MOVE_DESTINATION_UNKNOWN`		Move Destination unknown.
`OUT_OF_RESOURCES_UNABLE_TO_CALCULATE_NUMBER_OF_MATCHES`		Out of resources - Unable to calculate number of matches.
`OUT_OF_RESOURCES_UNABLE_TO_PERFORM_SUB_OPERATIONS`		Out of resources - Unable to perform sub-operations.
`PENDING`		Sub-operations are continuing.
`SUB_OPERATIONS_COMPLETE_ONE_OR_MORE_FAILURES`		Sub-operations Complete - One or more Failures.
`SUCCESS`		Sub-operations Complete - No Failures.
`UNKNOWN`		Unknown.

CANCEL ¶

CANCEL = 65024

Cancel.

DATASET_DOESNT_MATCH_SOP_CLASS ¶

DATASET_DOESNT_MATCH_SOP_CLASS = 43264

Data Set does not match SOP Class.

FAILED_UNABLE_TO_PROCESS ¶

FAILED_UNABLE_TO_PROCESS = 49152

Unable to process.

MOVE_DESTINATION_UNKNOWN ¶

MOVE_DESTINATION_UNKNOWN = 43009

Move Destination unknown.

OUT_OF_RESOURCES_UNABLE_TO_CALCULATE_NUMBER_OF_MATCHES ¶

OUT_OF_RESOURCES_UNABLE_TO_CALCULATE_NUMBER_OF_MATCHES = (
    42753
)

Out of resources - Unable to calculate number of matches.

OUT_OF_RESOURCES_UNABLE_TO_PERFORM_SUB_OPERATIONS ¶

OUT_OF_RESOURCES_UNABLE_TO_PERFORM_SUB_OPERATIONS = 42754

Out of resources - Unable to perform sub-operations.

PENDING ¶

PENDING = 65280

Sub-operations are continuing.

SUB_OPERATIONS_COMPLETE_ONE_OR_MORE_FAILURES ¶

SUB_OPERATIONS_COMPLETE_ONE_OR_MORE_FAILURES = 45056

Sub-operations Complete - One or more Failures.

SUCCESS ¶

SUCCESS = 0

Sub-operations Complete - No Failures.

UNKNOWN ¶

UNKNOWN = 4660

Unknown.

RetrieveError ¶

RetrieveError(response: Dataset)

Bases: Exception

Exception raised when a retrieve operation fails.

RetrieveResult ¶

RetrieveResult(
    status: DicomStatus = UNKNOWN,
    completed: int | None = None,
    failed: int | None = None,
    remaining: int | None = None,
    warning: int | None = None,
)

The result of a retrieve operation.

Methods:

Name	Description
`update`	Update.

Attributes:

Name	Type	Description
`completed`	`int \| None`	Completed sub-operations.
`failed`	`int \| None`	Failed sub-operations.
`remaining`	`int \| None`	Remaining sub-operations.
`status`	`DicomStatus`	Status of the retrieve operation.
`warning`	`int \| None`	Warnings.

completed ¶

completed: int | None = None

Completed sub-operations.

failed ¶

failed: int | None = None

Failed sub-operations.

remaining ¶

remaining: int | None = None

Remaining sub-operations.

status ¶

status: DicomStatus = UNKNOWN

Status of the retrieve operation.

warning ¶

warning: int | None = None

Warnings.

update ¶

update(dataset: Dataset) -> None

Update.

process_responses ¶

process_responses(
    responses: Iterator[tuple[Dataset, Dataset | None]],
    retrieve_callback: Callable[[RetrieveResult], None],
) -> RetrieveResult

Process the retrieve responses.