Open Chat
Version 0.3.1-beta.1
github.com/mercure-imaging/mercure
User Guide
What is mercure?
Quick Start
Installation
Usage
Advanced Topics
Monitoring
Dashboard Gallery
FAQ
Modules
Module Development
Existing Modules
Anonymizer
DCMAnnotate
Support
Discussion Board
Release History
Developer Information
Development Environment
Code Documentation
Roadmap
mercure
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
ACC (common.constants.mercure_info attribute)
acc (common.types.TaskInfo attribute)
accept_compressed_images (common.types.Config attribute)
access_key_id (common.types.S3Target attribute)
access_token (common.types.DicomWebTarget attribute)
ACTION (common.constants.mercure_info attribute)
(common.constants.mercure_rule attribute)
action (common.types.Rule attribute)
(common.types.TaskInfo attribute)
ACTION_TRIGGER (common.constants.mercure_rule attribute)
action_trigger (common.types.Rule attribute)
add_dispatching() (in module routing.generate_taskfile)
add_info() (in module routing.generate_taskfile)
add_module() (in module webinterface.modules)
add_new_user() (in module webinterface.users)
add_processing() (in module routing.generate_taskfile)
add_rule() (in module webinterface.rules)
add_study() (in module routing.generate_taskfile)
add_target() (in module webinterface.targets)
additional_tags (common.types.DicomReceiverConfig attribute)
additional_volumes (common.types.Module attribute)
aet_source (common.types.DicomTarget attribute)
(common.types.DicomTLSTarget attribute)
aet_target (common.types.DicomTarget attribute)
(common.types.DicomTLSTarget attribute)
appliance_name (common.types.Config attribute)
applied_rule (common.types.TaskInfo attribute)
async_post() (in module common.monitor)
async_run() (in module webinterface.common)
async_run_exec() (in module webinterface.common)
async_send_task_event() (in module common.monitor)
AsyncTimer (class in common.helper)
authenticate() (webgui.SessionAuthBackend method)
B
BadRequestResponse (class in webinterface.modules)
bookkeeper
module
bookkeeper (common.types.Config attribute)
bookkeeper_api_key (common.types.Config attribute)
BOTH (common.constants.mercure_actions attribute)
bucket (common.types.S3Target attribute)
C
ca_cert (common.types.DicomTLSTarget attribute)
change_password (webinterface.users.User attribute)
check_folders() (in module common.config)
check_study_series() (in module routing.route_studies)
check_study_timeout() (in module routing.route_studies)
clean() (in module cleaner)
clean_dir() (in module cleaner)
cleaner
module
cleaner_scan_interval (common.types.Config attribute)
comment (common.types.Module attribute)
(common.types.Rule attribute)
(common.types.Target attribute)
common.config
module
common.constants
module
common.helper
module
common.monitor
module
common.notification
module
common.rule_evaluation
module
common.tagslist
module
common.types
module
Compat (class in common.types)
COMPLETE_FORCE (common.constants.mercure_study attribute)
complete_force (common.types.TaskStudy attribute)
COMPLETE_REQUIRED_SERIES (common.constants.mercure_study attribute)
complete_required_series (common.types.TaskStudy attribute)
COMPLETE_TRIGGER (common.constants.mercure_study attribute)
complete_trigger (common.types.TaskStudy attribute)
COMPLETED (common.constants.mercure_events attribute)
compose_task() (in module routing.generate_taskfile)
Config (class in common.types)
configuration() (in module webgui)
configuration_edit() (in module webgui)
configuration_edit_post() (in module webgui)
configure() (in module common.monitor)
constraints (common.types.Module attribute)
contact (common.types.Module attribute)
(common.types.Rule attribute)
(common.types.Target attribute)
control_services() (in module webgui)
create_arg_parser() (in module dispatch.process_dcmsend_result)
create_database() (in module bookkeeper)
create_series_task() (in module routing.generate_taskfile)
create_study_task() (in module routing.generate_taskfile)
create_users() (in module webinterface.users)
CREATION_TIME (common.constants.mercure_study attribute)
creation_time (common.types.TaskStudy attribute)
D
DCM (common.constants.mercure_names attribute)
DCMFILTER (common.constants.mercure_names attribute)
delete_folder() (in module cleaner)
delete_module() (in module webinterface.modules)
delete_old_tests() (in module webgui)
device_serial_number (common.types.TaskInfo attribute)
dicom_receiver (common.types.Config attribute)
DicomReceiverConfig (class in common.types)
DicomTarget (class in common.types)
DicomTLSTarget (class in common.types)
DicomWebTarget (class in common.types)
DISABLED (common.constants.mercure_rule attribute)
disabled (common.types.Rule attribute)
DISCARD (common.constants.mercure_actions attribute)
(common.constants.mercure_folders attribute)
discard_folder (common.types.Config attribute)
discard_logs (common.types.ProcessingLogsConfig attribute)
DISPATCH (common.constants.mercure_sections attribute)
dispatch (common.types.Task attribute)
dispatch() (in module dispatcher)
dispatch.process_dcmsend_result
module
dispatch.retry
module
dispatch.send
module
dispatch.status
module
dispatcher
module
dispatcher_scan_interval (common.types.Config attribute)
do_post() (in module common.monitor)
docker_arguments (common.types.Module attribute)
docker_runtime() (in module process.process_series)
docker_tag (common.types.Module attribute)
DummyTarget (class in common.types)
E
edit_module() (in module webinterface.modules)
edit_module_POST() (in module webinterface.modules)
email (webinterface.users.User attribute)
email_notification_from (common.types.Config attribute)
emergency_clean_percentage (common.types.Config attribute)
emergency_response() (in module webgui)
EmptyDict (class in common.types)
environment (common.types.Module attribute)
ERROR (common.constants.mercure_events attribute)
(common.constants.mercure_folders attribute)
(common.constants.mercure_names attribute)
error() (in module webgui)
error_folder (common.types.Config attribute)
eval_rule() (in module common.rule_evaluation)
evaluate_password() (in module webinterface.users)
exit_cleaner() (in module cleaner)
exit_dispatcher() (in module dispatcher)
exit_processor() (in module processor)
exit_router() (in module router)
ExtendedUser (class in webgui)
extra (common.types.Task.Config attribute)
F
FALLBACK (common.constants.mercure_rule attribute)
fallback (common.types.Rule attribute)
FALSE (common.constants.mercure_options attribute)
features (common.types.Config attribute)
FileLock (class in common.helper)
FILES (common.constants.mercure_sections attribute)
find_series_uid() (in module cleaner)
find_tasks() (in module common.monitor)
folder (common.types.FolderTarget attribute)
(common.types.RsyncTarget attribute)
(common.types.SftpTarget attribute)
FolderTarget (class in common.types)
FORCE_COMPLETE (common.constants.mercure_names attribute)
force_study_complete() (in module webinterface.queue)
free() (common.helper.FileLock method)
G
g_log() (in module common.helper)
get() (common.types.Compat method)
(in module common.monitor)
get_jobinfo() (in module webinterface.queue)
get_name() (common.types.Target class method)
get_nomad_logs() (in module webgui)
get_runner() (in module common.helper)
get_series() (in module common.monitor)
get_task_custom_notification() (in module common.notification)
get_task_events() (in module common.monitor)
get_task_info() (in module common.monitor)
get_task_requested_notification() (in module common.notification)
get_tasks() (in module common.monitor)
get_tests() (in module common.monitor)
get_triggered_rules() (in module routing.route_series)
get_user_information() (in module webinterface.common)
graphite_ip (common.types.Config attribute)
graphite_port (common.types.Config attribute)
H
HALT (common.constants.mercure_names attribute)
handle_processor_output() (in module process.process_series)
hash_password() (in module webinterface.users)
homepage() (in module webgui)
host (common.types.RsyncTarget attribute)
(common.types.SftpTarget attribute)
(common.types.XnatTarget attribute)
http_password (common.types.DicomWebTarget attribute)
http_user (common.types.DicomWebTarget attribute)
I
id (common.types.Task attribute)
INCOMING (common.constants.mercure_folders attribute)
incoming_folder (common.types.Config attribute)
increase_retry() (in module dispatch.retry)
influxdb_bucket (common.types.Config attribute)
influxdb_host (common.types.Config attribute)
influxdb_org (common.types.Config attribute)
influxdb_token (common.types.Config attribute)
INFO (common.constants.mercure_sections attribute)
info (common.types.Task attribute)
INVALID (common.constants.mercure_options attribute)
ip (common.types.DicomTarget attribute)
(common.types.DicomTLSTarget attribute)
is_admin (webgui.ExtendedUser property)
(webinterface.users.User attribute)
is_admin() (in module webinterface.users)
is_ready_for_processing() (in module process.status)
is_ready_for_sending() (in module dispatch.status)
is_study_complete() (in module routing.route_studies)
is_study_locked() (in module routing.route_studies)
is_target_json_valid() (in module dispatch.status)
is_terminated() (in module common.helper)
J
JOURNAL (common.constants.mercure_sections attribute)
L
LAST_RECEIVE_TIME (common.constants.mercure_study attribute)
last_receive_time (common.types.TaskStudy attribute)
launch_emergency_app() (in module webgui)
LOCK (common.constants.mercure_names attribute)
lockCreated (common.helper.FileLock attribute)
login() (in module webgui)
login_post() (in module webgui)
logout() (in module webgui)
logs_file_store (common.types.ProcessingLogsConfig attribute)
M
main() (in module bookkeeper)
(in module cleaner)
(in module dispatcher)
(in module processor)
(in module router)
(in module webgui)
mercure (in module common.config)
mercure_actions (class in common.constants)
MERCURE_APPLIANCE (common.constants.mercure_info attribute)
mercure_appliance (common.types.TaskInfo attribute)
mercure_config (class in common.constants)
mercure_defs (class in common.constants)
mercure_events (class in common.constants)
mercure_folders (class in common.constants)
mercure_info (class in common.constants)
mercure_names (class in common.constants)
mercure_options (class in common.constants)
mercure_rule (class in common.constants)
mercure_sections (class in common.constants)
MERCURE_SERVER (common.constants.mercure_info attribute)
mercure_server (common.types.TaskInfo attribute)
mercure_study (class in common.constants)
MERCURE_VERSION (common.constants.mercure_info attribute)
mercure_version (common.types.TaskInfo attribute)
MISSING (common.constants.mercure_options attribute)
module
bookkeeper
cleaner
common.config
common.constants
common.helper
common.monitor
common.notification
common.rule_evaluation
common.tagslist
common.types
dispatch.process_dcmsend_result
dispatch.retry
dispatch.send
dispatch.status
dispatcher
process.process_series
process.status
processor
router
routing.generate_taskfile
routing.route_series
routing.route_studies
webgui
webinterface.common
webinterface.modules
webinterface.queue
webinterface.rules
webinterface.services
webinterface.targets
webinterface.users
Module (class in common.types)
module_config (common.types.TaskProcessing attribute)
module_name (common.types.TaskProcessing attribute)
MODULES (common.constants.mercure_config attribute)
modules (common.types.Config attribute)
MonitorHTTPError
move_out_folder() (in module process.process_series)
move_results() (in module process.process_series)
move_study_folder() (in module routing.route_studies)
MRN (common.constants.mercure_info attribute)
mrn (common.types.TaskInfo attribute)
N
needs_change_password() (in module webinterface.users)
next_retry_at (common.types.TaskDispatch attribute)
nomad_info (common.types.Task attribute)
nomad_runtime() (in module process.process_series)
NORMAL (common.constants.mercure_options attribute)
not_found() (in module webgui)
NOTIFICATION (common.constants.mercure_actions attribute)
(common.constants.mercure_sections attribute)
notification_email (common.types.Rule attribute)
notification_email_body (common.types.Rule attribute)
notification_email_type (common.types.Rule attribute)
NOTIFICATION_PAYLOAD (common.constants.mercure_rule attribute)
notification_payload (common.types.Rule attribute)
notification_payload_body (common.types.Rule attribute)
NOTIFICATION_TRIGGER_COMPLETION (common.constants.mercure_rule attribute)
notification_trigger_completion (common.types.Rule attribute)
notification_trigger_completion_on_request (common.types.Rule attribute)
NOTIFICATION_TRIGGER_ERROR (common.constants.mercure_rule attribute)
notification_trigger_error (common.types.Rule attribute)
NOTIFICATION_TRIGGER_RECEPTION (common.constants.mercure_rule attribute)
notification_trigger_reception (common.types.Rule attribute)
NOTIFICATION_WEBHOOK (common.constants.mercure_rule attribute)
notification_webhook (common.types.Rule attribute)
O
OFFPEAK (common.constants.mercure_options attribute)
offpeak_end (common.types.Config attribute)
offpeak_start (common.types.Config attribute)
OUTGOING (common.constants.mercure_folders attribute)
outgoing_folder (common.types.Config attribute)
output (common.types.TaskProcessing attribute)
P
parse() (in module dispatch.process_dcmsend_result)
parse_and_submit_tags() (in module bookkeeper)
parse_completion_series() (in module common.rule_evaluation)
parse_payload() (in module common.notification)
parse_rule() (in module common.rule_evaluation)
password (common.types.RsyncTarget attribute)
(common.types.SftpTarget attribute)
(common.types.XnatTarget attribute)
(webinterface.users.User attribute)
patient_name (common.types.TaskInfo attribute)
permissions (webinterface.users.User attribute)
port (common.types.Config attribute)
(common.types.DicomTarget attribute)
(common.types.DicomTLSTarget attribute)
post() (in module common.monitor)
(in module common.notification)
post_mercure_event() (in module bookkeeper)
post_task_event() (in module bookkeeper)
post_webgui_event() (in module bookkeeper)
prefix (common.types.S3Target attribute)
PRIORITY (common.constants.mercure_rule attribute)
priority (common.types.Rule attribute)
PROCESS (common.constants.mercure_actions attribute)
(common.constants.mercure_sections attribute)
process (common.types.Task attribute)
process.process_series
module
process.status
module
process_runner (common.types.Config attribute)
PROCESSING (common.constants.mercure_folders attribute)
(common.constants.mercure_names attribute)
processing_folder (common.types.Config attribute)
processing_logs (common.types.Config attribute)
PROCESSING_MODULE (common.constants.mercure_rule attribute)
processing_module (common.types.Rule attribute)
processing_retain_images (common.types.Rule attribute)
processing_runtime (common.types.Config attribute)
processing_settings (common.types.Rule attribute)
ProcessingLogsConfig (class in common.types)
processor
module
processor_logs() (in module bookkeeper)
project_id (common.types.XnatTarget attribute)
push_files() (in module routing.route_series)
push_input_images() (in module process.process_series)
push_input_task() (in module process.process_series)
push_series_complete() (in module routing.route_series)
push_series_serieslevel() (in module routing.route_series)
push_series_studylevel() (in module routing.route_series)
push_serieslevel_notification() (in module routing.route_series)
push_serieslevel_outgoing() (in module routing.route_series)
push_serieslevel_processing() (in module routing.route_series)
push_serieslevel_routing() (in module routing.route_series)
push_studylevel_dispatch() (in module routing.route_studies)
push_studylevel_error() (in module routing.route_studies)
push_studylevel_notification() (in module routing.route_studies)
push_studylevel_processing() (in module routing.route_studies)
Q
qido_url_prefix (common.types.DicomWebTarget attribute)
R
read_config() (in module common.config)
read_services() (in module webinterface.services)
read_tagslist() (in module common.config)
read_users() (in module webinterface.users)
RECEIVED (common.constants.mercure_events attribute)
RECEIVED_SERIES (common.constants.mercure_study attribute)
received_series (common.types.TaskStudy attribute)
received_series_uid (common.types.TaskStudy attribute)
region (common.types.S3Target attribute)
register_dicom() (in module bookkeeper)
register_series() (in module bookkeeper)
register_task() (in module bookkeeper)
remove_series() (in module routing.route_series)
remove_study_folder() (in module routing.route_studies)
RepeatedTimer (class in common.helper)
replace_tags() (in module common.rule_evaluation)
requires_root (common.types.Module attribute)
resources (common.types.Module attribute)
retain_input_images (common.types.TaskProcessing attribute)
retention (common.types.Config attribute)
retries (common.types.TaskDispatch attribute)
retry_delay (common.types.Config attribute)
retry_max (common.types.Config attribute)
ROUTE (common.constants.mercure_actions attribute)
route_error_files() (in module routing.route_series)
route_studies() (in module routing.route_studies)
router
module
router_scan_interval (common.types.Config attribute)
routing.generate_taskfile
module
routing.route_series
module
routing.route_studies
module
RsyncTarget (class in common.types)
Rule (class in common.types)
RULE (common.constants.mercure_rule attribute)
rule (common.types.Rule attribute)
(common.types.UnsetRule attribute)
RULES (common.constants.mercure_config attribute)
rules (common.types.Config attribute)
rules_delete_post() (in module webinterface.rules)
rules_edit() (in module webinterface.rules)
rules_edit_post() (in module webinterface.rules)
rules_test() (in module webinterface.rules)
rules_test_completionseries() (in module webinterface.rules)
run_on_complete (common.types.RsyncTarget attribute)
run_processor() (in module processor)
run_router() (in module router)
run_until_complete() (common.helper.AsyncTimer method)
RUNNING (common.constants.mercure_names attribute)
S
S3Target (class in common.types)
save_config() (in module common.config)
save_module() (in module webinterface.modules)
save_users() (in module webinterface.users)
search_folder() (in module processor)
secret_access_key (common.types.S3Target attribute)
self_test() (in module webgui)
self_test_cleanup() (in module webgui)
self_test_notification() (in module webgui)
send_email() (in module common.notification)
send_email_helper() (in module common.notification)
send_event() (in module common.monitor)
send_process_logs() (in module common.monitor)
send_processor_output() (in module common.monitor)
send_register_series() (in module common.monitor)
send_register_task() (in module common.monitor)
send_task_event() (in module common.monitor)
send_to_graphite() (in module common.helper)
send_to_influxdb() (in module common.helper)
send_update_task() (in module common.monitor)
send_webgui_event() (in module common.monitor)
send_webhook() (in module common.notification)
sender_address (common.types.TaskInfo attribute)
SENDLOG (common.constants.mercure_names attribute)
SEPARATOR (common.constants.mercure_defs attribute)
SERIES (common.constants.mercure_options attribute)
series_complete_trigger (common.types.Config attribute)
series_uid (common.types.TaskDispatch attribute)
server_error() (in module bookkeeper)
(in module webgui)
ServerErrorResponse (class in webinterface.modules)
SessionAuthBackend (class in webgui)
set_api_key() (in module common.monitor)
set_queues_status() (in module webinterface.queue)
settings (common.types.Module attribute)
(common.types.TaskProcessing attribute)
settings_edit() (in module webgui)
setup() (in module common.notification)
SftpTarget (class in common.types)
show_first_log() (in module webgui)
show_jobs_fail() (in module webinterface.queue)
show_jobs_processing() (in module webinterface.queue)
show_jobs_routing() (in module webinterface.queue)
show_jobs_studies() (in module webinterface.queue)
show_log() (in module webgui)
show_modules() (in module webinterface.modules)
show_queues() (in module webinterface.queue)
show_queues_status() (in module webinterface.queue)
show_rules() (in module webinterface.rules)
show_targets() (in module webinterface.targets)
show_users() (in module webinterface.users)
shutdown() (in module bookkeeper)
(in module webgui)
start() (common.helper.AsyncTimer method)
(common.helper.RepeatedTimer method)
startup() (in module bookkeeper)
(in module webgui)
stop() (common.helper.AsyncTimer method)
(common.helper.RepeatedTimer method)
store_processor_output() (in module bookkeeper)
stow_url_prefix (common.types.DicomWebTarget attribute)
STUDIES (common.constants.mercure_folders attribute)
studies_folder (common.types.Config attribute)
STUDY (common.constants.mercure_options attribute)
(common.constants.mercure_sections attribute)
study (common.types.Task attribute)
(common.types.TaskHasStudy attribute)
study_complete_trigger (common.types.Config attribute)
study_forcecomplete_trigger (common.types.Config attribute)
STUDY_TRIGGER (common.constants.mercure_rule attribute)
STUDY_TRIGGER_CONDITION (common.constants.mercure_rule attribute)
study_trigger_condition (common.types.Rule attribute)
STUDY_TRIGGER_CONDITION_RECEIVED_SERIES (common.constants.mercure_rule attribute)
STUDY_TRIGGER_CONDITION_TIMEOUT (common.constants.mercure_rule attribute)
study_trigger_series (common.types.Rule attribute)
STUDY_UID (common.constants.mercure_study attribute)
study_uid (common.types.TaskStudy attribute)
SUCCESS (common.constants.mercure_folders attribute)
success_folder (common.types.Config attribute)
support_root_modules (common.types.Config attribute)
T
TAGS (common.constants.mercure_names attribute)
tags (common.types.Rule attribute)
Target (class in common.types)
TARGET (common.constants.mercure_rule attribute)
target (common.types.Rule attribute)
target_name (common.types.TaskDispatch attribute)
target_type (common.types.DicomTarget attribute)
(common.types.DicomTLSTarget attribute)
(common.types.DicomWebTarget attribute)
(common.types.DummyTarget attribute)
(common.types.FolderTarget attribute)
(common.types.RsyncTarget attribute)
(common.types.S3Target attribute)
(common.types.SftpTarget attribute)
(common.types.XnatTarget attribute)
TARGETS (common.constants.mercure_config attribute)
targets (common.types.Config attribute)
targets_delete_post() (in module webinterface.targets)
targets_edit() (in module webinterface.targets)
targets_edit_post() (in module webinterface.targets)
targets_test_post() (in module webinterface.targets)
Task (class in common.types)
Task.Config (class in common.types)
task_event_payload() (in module common.monitor)
task_process_logs() (in module common.monitor)
TaskDispatch (class in common.types)
TASKFILE (common.constants.mercure_names attribute)
TaskHasStudy (class in common.types)
TaskInfo (class in common.types)
TaskProcessing (class in common.types)
TaskStudy (class in common.types)
terminate_process() (in module cleaner)
(in module dispatcher)
(in module processor)
(in module router)
test_begin() (in module bookkeeper)
test_completion_series() (in module common.rule_evaluation)
test_end() (in module bookkeeper)
test_endpoint() (in module bookkeeper)
tls_cert (common.types.DicomTLSTarget attribute)
tls_key (common.types.DicomTLSTarget attribute)
TokenAuth (class in bookkeeper)
trigger_notification() (in module process.process_series)
trigger_notification_for_rule() (in module common.notification)
trigger_serieslevel_notification() (in module routing.route_series)
trigger_studylevel_notification() (in module routing.route_studies)
trigger_terminate() (in module common.helper)
TRIGGERED_RULES (common.constants.mercure_info attribute)
triggered_rules (common.types.TaskInfo attribute)
TRUE (common.constants.mercure_options attribute)
U
UID (common.constants.mercure_info attribute)
uid (common.types.TaskInfo attribute)
UID_TYPE (common.constants.mercure_info attribute)
uid_type (common.types.TaskInfo attribute)
UnsetRule (class in common.types)
update_study_task() (in module routing.generate_taskfile)
update_task() (in module bookkeeper)
URGENT (common.constants.mercure_options attribute)
url (common.types.DicomWebTarget attribute)
User (class in webinterface.users)
user (common.types.RsyncTarget attribute)
(common.types.SftpTarget attribute)
(common.types.XnatTarget attribute)
users_delete_post() (in module webinterface.users)
users_edit() (in module webinterface.users)
users_edit_post() (in module webinterface.users)
V
validate() (common.types.Target class method)
verify() (bookkeeper.TokenAuth method)
VERSION (common.constants.mercure_defs attribute)
W
wado_url_prefix (common.types.DicomWebTarget attribute)
webgui
module
webhook_certificate_location (common.types.Config attribute)
webinterface.common
module
webinterface.modules
module
webinterface.queue
module
webinterface.rules
module
webinterface.services
module
webinterface.targets
module
webinterface.users
module
write_configfile() (in module common.config)
X
XnatTarget (class in common.types)