dxtbx.imageset

class dxtbx.imageset.FilenameAnalyser[source]

Bases: object

Group images by filename into image sets.

class dxtbx.imageset.ImageSetAux[source]

Bases: boost.python.injector, dxtbx_imageset_ext.ImageSet

A class to inject additional methods into the imageset class

get_detectorbase(index)[source]

A function to be injected into the imageset to get the detectorbase instance

get_format_class()[source]

Get format class name

get_vendortype(index)[source]

Get the vendor information.

masker()[source]

Return the masker

params()[source]

Get the parameters

paths()[source]

Return the list of paths

reader()[source]

Return the reader

class dxtbx.imageset.ImageSetFactory[source]

Bases: object

Factory to create imagesets and sweeps.

static from_template(template, image_range=None, check_headers=False, check_format=True, beam=None, detector=None, goniometer=None, scan=None)[source]

Create a new sweep from a template.

Params:
template The template argument image_range The image range check_headers Check the headers to ensure all images are valid
Returns:A list of sweeps
static imageset_from_anyset(imageset)[source]

Create a new ImageSet object from an imageset object. Converts ImageSweep to ImageSet.

static make_imageset(filenames, format_class=None, check_format=True, single_file_indices=None, format_kwargs=None)[source]

Create an image set

static make_sweep(template, indices, format_class=None, beam=None, detector=None, goniometer=None, scan=None, check_format=True, format_kwargs=None)[source]

Create a sweep

static new(filenames, check_headers=False, ignore_unknown=False)[source]

Create an imageset or sweep

Params:
filenames A list of filenames check_headers Check the headers to ensure all images are valid ignore_unknown Ignore unknown formats
Returns:A list of imagesets
class dxtbx.imageset.ImageSetLazy[source]

Bases: dxtbx_imageset_ext.ImageSet

Lazy ImageSet class that doesn’t necessitate setting the models ahead of time. Only when a particular model (like detector or beam) for an image is requested, it sets the model using the format class and then returns the model

get_beam((ImageSet)arg1[, (int)index=0]) → BeamBase :[source]
C++ signature :
boost::shared_ptr<dxtbx::model::BeamBase> get_beam(dxtbx::ImageSet {lvalue} [,unsigned long=0])
get_corrected_data((ImageSet)arg1, (int)arg2) → tuple :[source]
C++ signature :
boost::python::tuple get_corrected_data(dxtbx::ImageSet {lvalue},unsigned long)
get_detector((ImageSet)arg1[, (int)index=0]) → Detector :[source]
C++ signature :
boost::shared_ptr<dxtbx::model::Detector> get_detector(dxtbx::ImageSet {lvalue} [,unsigned long=0])
get_gain((ImageSet)arg1, (int)arg2) → tuple :[source]
C++ signature :
boost::python::tuple get_gain(dxtbx::ImageSet {lvalue},unsigned long)
get_goniometer((ImageSet)arg1[, (int)index=0]) → Goniometer :[source]
C++ signature :
boost::shared_ptr<dxtbx::model::Goniometer> get_goniometer(dxtbx::ImageSet {lvalue} [,unsigned long=0])
get_scan((ImageSet)arg1[, (int)index=0]) → Scan :[source]
C++ signature :
boost::shared_ptr<dxtbx::model::Scan> get_scan(dxtbx::ImageSet {lvalue} [,unsigned long=0])
class dxtbx.imageset.ImageSweepAux[source]

Bases: boost.python.injector, dxtbx_imageset_ext.ImageSweep

get_template()[source]

Return the template

class dxtbx.imageset.MemMasker(images)[source]

Bases: object

get(index, goniometer=None)[source]
identifiers()[source]
paths()[source]
class dxtbx.imageset.MemReader(images)[source]

Bases: object

A reader for data already loaded in memory

identifiers()[source]
is_single_file_reader()[source]
master_path()[source]
paths()[source]
read(index)[source]