SCP

Functions:

Name	Description
dataset_to_filename_template_dict	Create a dictionary from a pydicom.Dataset instance of selected tags.
dummy_anonymize	Dummy implementation, return input value
dummy_filename_callback	Dummy implementation
dummy_mapping	Dummy implementation, return input value
dummy_retrieve_progress	Dummy implementation
get_prefix	Get the filename prefix based on SOPClassUID.
handle_store	Callback function for storing a DICOM dataset.

Attributes:

Name	Type	Description
Anonymizer		Anonymizer function.

Anonymizer

Anonymizer = Callable[[Dataset], Dataset]

Anonymizer function.

dataset_to_filename_template_dict

dataset_to_filename_template_dict(
    dataset: Dataset,
) -> dict[str, str]

Create a dictionary from a pydicom.Dataset instance of selected tags.

dummy_anonymize

dummy_anonymize(_data: Dataset) -> Dataset

Dummy implementation, return input value

dummy_filename_callback

dummy_filename_callback(_: Path) -> None

Dummy implementation

dummy_mapping

dummy_mapping(val: str) -> str

Dummy implementation, return input value

dummy_retrieve_progress

dummy_retrieve_progress(_data: RetrieveResult) -> None

Dummy implementation

get_prefix

get_prefix(dataset: Dataset) -> str

Get the filename prefix based on SOPClassUID.

handle_store

handle_store(
    event: Event,
    base_folder: Path,
    folder_template: str,
    anonimyzer: Anonymizer,
    uid_mapping: Callable[[str], str],
    folder_callback: Callable[[Path], None],
    sop_class_uid: Iterable[str] | None,
) -> int

Callback function for storing a DICOM dataset.

Parameters:

Name	Type	Description	Default
event	Event	The dataset to store.	required
base_folder	Path	Base folder for storing files.	required
folder_template	str	Template for creating folders inside the base_folder.	required
anonimyzer	Anonymizer	Anonymizer to anonymize the dataset.	required
uid_mapping	Callable[[str], str]	Mapping from UID to series index.	required
folder_callback	Callable[[Path], None]	Callback function for returning the final path.	required
sop_class_uid	Iterable[str] | None	Optional SOPClassUIDs to process, others will be ignored.	required

Returns:

Type	Description
int	DICOM status code.