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

dxtbx.datablock

class dxtbx.datablock.AutoEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, encoding='utf-8', default=None)

Bases: json.encoder.JSONEncoder

default(obj)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return JSONEncoder.default(self, o)

class dxtbx.datablock.BeamComparison(wavelength_tolerance=1e-06, direction_tolerance=1e-06, polarization_normal_tolerance=1e-06, polarization_fraction_tolerance=1e-06)

Bases: object

A class to provide simple beam comparison

class dxtbx.datablock.BeamDiff(wavelength_tolerance=1e-06, direction_tolerance=1e-06, polarization_normal_tolerance=1e-06, polarization_fraction_tolerance=1e-06)

Bases: object

A class to provide simple beam comparison

class dxtbx.datablock.DataBlock(imagesets)

Bases: object

High level container for blocks of sweeps and imagesets.

append(imageset)

Add an imageset to the block.

extend(datablock)

Add two datablocks.

extract_imagesets()

Extract all imagesets.

extract_stills()

Extract all the still imagesets

extract_sweeps()

Extract all the sweeps from the block.

format_class()

Return the format class.

iter_stills()

Iterate over still groups.

iter_sweeps()

Iterate over sweep groups.

num_images()

Get the number of images.

to_dict()

Convert the datablock to a dictionary

unique_beams()

Iterate through unique beams.

unique_detectors()

Returns a list of detector objects.

unique_goniometers()

Iterate through unique goniometers.

unique_scans()

Iterate through unique scans.

class dxtbx.datablock.DataBlockDictImporter(obj, check_format=True, directory=None)

Bases: object

A class to import a datablock from dictionary.

class dxtbx.datablock.DataBlockDumper(datablocks)

Bases: object

Class to help in dumping datablock objects.

as_file(filename, **kwargs)

Dump datablocks as file.

as_json(filename=None, compact=False)

Dump datablock as json.

as_pickle(filename=None, **kwargs)

Dump datablock as pickle.

class dxtbx.datablock.DataBlockFactory

Bases: object

Class for creating DataBlock instances

static from_args(args, verbose=False, unhandled=None, compare_beam=None, compare_detector=None, compare_goniometer=None, scan_tolerance=None, format_kwargs=None)

Try to load datablocks from any recognized format.

static from_dict(obj, check_format=True, directory=None)

Create a datablock from a dictionary.

static from_filenames(filenames, verbose=False, unhandled=None, compare_beam=None, compare_detector=None, compare_goniometer=None, scan_tolerance=None, format_kwargs=None)

Create a list of data blocks from a list of directory or file names.

static from_imageset(imagesets)

Load a datablock from an imageset of list of imagesets.

static from_imageset_json_file(filename)

Load a datablock from a sweep file.

static from_in_memory(images, indices=None)

Function to instantiate data block from in memory imageset.

static from_json(string, check_format=True, directory=None)

Decode a datablock from JSON string.

static from_json_file(filename, check_format=True)

Decode a datablock from a JSON file.

static from_pickle_file(filename)

Decode a datablock from a pickle file.

static from_serialized_format(filename, check_format=True)

Load a datablock from serialized formats.

class dxtbx.datablock.DataBlockFilenameImporter(filenames, verbose=False, compare_beam=None, compare_detector=None, compare_goniometer=None, scan_tolerance=None, format_kwargs=None)

Bases: object

A class to import a datablock from image files.

class dxtbx.datablock.DataBlockImageSetImporter(imagesets)

Bases: object

A class to import a datablock from imagesets.

class dxtbx.datablock.DataBlockTemplateImporter(templates, verbose=False, **kwargs)

Bases: object

A class to import a datablock from a template.

class dxtbx.datablock.DetectorComparison(fast_axis_tolerance=1e-06, slow_axis_tolerance=1e-06, origin_tolerance=1e-06)

Bases: object

A class to provide simple detector comparison

class dxtbx.datablock.DetectorDiff(fast_axis_tolerance=1e-06, slow_axis_tolerance=1e-06, origin_tolerance=1e-06)

Bases: object

A class to provide simple detector comparison

class dxtbx.datablock.FormatChecker(verbose=False)

Bases: object

A helper class to find the image format by first checking the last format that was used.

check_child_formats(filename)

If a child format understands the file better than return that, otherwise return the current format.

find_format(filename)

Check the current and child formats, otherwise search the registry.

iter_groups(filenames)

understand(filename)

Check if the data block format understands the given file. This function checks the method resolution order for the format class and calls the understand methods of each parent down to the bottom level. Just calling the format class understand method directly can result in problems. This is really a workaround for a bug in the way that the format understand method works. Furthermore, the FormatStill class does not have an understand method so we have to check that the “understand” method is present in the class dictionary before we actually do the call.

class dxtbx.datablock.GoniometerComparison(rotation_axis_tolerance=1e-06, fixed_rotation_tolerance=1e-06, setting_rotation_tolerance=1e-06)

Bases: object

A class to provide simple goniometer comparison

class dxtbx.datablock.GoniometerDiff(rotation_axis_tolerance=1e-06, fixed_rotation_tolerance=1e-06, setting_rotation_tolerance=1e-06)

Bases: object

A class to provide simple goniometer comparison

exception dxtbx.datablock.InvalidDataBlockError

Bases: exceptions.RuntimeError

Indicates an error whilst validating the experiment list.

This means that there is some structural problem that prevents the given data from representing a well-formed experiment list. This doesn’t indicate e.g. some problem with the data or model consistency.

class dxtbx.datablock.ScanDiff(scan_tolerance=1e-06)

Bases: object

A class to provide scan comparison

class dxtbx.datablock.SweepDiff(tolerance)

Bases: object

dxtbx.datablock.all_approx_equal(a, b, tol)

dxtbx.datablock.all_equal(a, b)