This documentation page refers to a previous release of DIALS (1.14).
Click here to go to the corresponding page for the latest version of DIALS

dials.apply_mask

Introduction

This program augments a datablock or experiement list .json file with one or more masks specified by the user. Its only function is to input the mask file paths to the .json file, but means that the user does not have to edit the file by hand.

Crucially, the mask files must be provided in the same order as their corresponding imagesets (sweeps) appear in the .json file.

Examples:

dials.apply_mask datablock.json input.mask=mask.pickle

dials.apply_mask experiments.json input.mask=mask1.pickle input.mask=mask2.pickle

Basic parameters

input {
  mask = None
}
output {
  datablock = masked_datablock.json
  experiments = masked_experiments.json
}

Full parameter definitions

input {
  mask = None
    .help = "The mask filenames, one mask per imageset"
    .type = str
    .multiple = True
}
output {
  datablock = masked_datablock.json
    .help = "Name of output datablock file"
    .type = str
  experiments = masked_experiments.json
    .help = "Name of output experiments file"
    .type = str
}