dials.algorithms.integration

Table of Contents

class dials.algorithms.integration.integrator.FinalizerBase(reflections, experiments, params)[source]

Bases: object

class dials.algorithms.integration.integrator.FinalizerRot(reflections, experiments, params)[source]

Bases: dials.algorithms.integration.integrator.FinalizerBase

A post-processing class for oscillation data.

class dials.algorithms.integration.integrator.FinalizerStills(reflections, experiments, params)[source]

Bases: dials.algorithms.integration.integrator.FinalizerBase

A post-processing class for stills data.

class dials.algorithms.integration.integrator.InitializerRot(experiments, params)[source]

Bases: object

A pre-processing class for oscillation data.

class dials.algorithms.integration.integrator.InitializerStills(experiments, params)[source]

Bases: object

A pre-processing class for stills data.

class dials.algorithms.integration.integrator.Integrator(experiments, reflections, params)[source]

Bases: object

The integrator class

integrate()[source]

Integrate the data

report()[source]

Return the report of the processing

summary(block_size, block_size_units)[source]

Print a summary of the integration stuff.

class dials.algorithms.integration.integrator.Integrator2D(experiments, reflections, params)[source]

Bases: dials.algorithms.integration.integrator.Integrator

Integrator for 2D algorithms

FinalizerClass

alias of FinalizerRot

InitializerClass

alias of InitializerRot

ProcessorClass

alias of dials.algorithms.integration.processor.Processor2D

class dials.algorithms.integration.integrator.Integrator3D(experiments, reflections, params)[source]

Bases: dials.algorithms.integration.integrator.Integrator

Integrator for 3D algorithms

FinalizerClass

alias of FinalizerRot

InitializerClass

alias of InitializerRot

ProcessorClass

alias of dials.algorithms.integration.processor.Processor3D

class dials.algorithms.integration.integrator.Integrator3DThreaded(experiments, reflections, params)[source]

Bases: object

Integrator for 3D algorithms

finalise()[source]

Finalise the integrator

initialise()[source]

Initialise the integrator

integrate()[source]

Integrate the data

report()[source]

Return the report of the processing

summary(block_size, block_size_units)[source]

Print a summary of the integration stuff.

class dials.algorithms.integration.integrator.IntegratorExecutor(experiments, profile_fitter=None)[source]

Bases: dials_algorithms_integration_integrator_ext.Executor

The class to process the integration data

data()[source]

Return data

finalize()[source]

Finalize the processing

initialize(frame0, frame1, reflections)[source]

Initialize the processing for the job

Parameters:
  • frame0 – The first frame to process
  • frame1 – The last frame to process
  • reflections – The reflections to process
process(frame, reflections)[source]

Process the reflections on a frame

Parameters:
  • frame – The frame to process
  • reflections – The reflections to process
class dials.algorithms.integration.integrator.IntegratorFactory[source]

Bases: object

A factory for creating integrators.

static create(experiments, reflections)[source]

Create the integrator from the input configuration.

Parameters:
  • params – The input phil parameters
  • experiments – The list of experiments
  • reflections – The reflections to integrate
Returns:

The integrator class

class dials.algorithms.integration.integrator.IntegratorFlat3D(experiments, reflections, params)[source]

Bases: dials.algorithms.integration.integrator.Integrator

Integrator for flattened 3D algorithms

FinalizerClass

alias of FinalizerRot

InitializerClass

alias of InitializerRot

ProcessorClass

alias of dials.algorithms.integration.processor.ProcessorFlat3D

class dials.algorithms.integration.integrator.IntegratorSingle2D(experiments, reflections, params)[source]

Bases: dials.algorithms.integration.integrator.Integrator

Integrator for 2D algorithms on a single image

FinalizerClass

alias of FinalizerRot

InitializerClass

alias of InitializerRot

ProcessorClass

alias of dials.algorithms.integration.processor.ProcessorSingle2D

class dials.algorithms.integration.integrator.IntegratorStills(experiments, reflections, params)[source]

Bases: dials.algorithms.integration.integrator.Integrator

Integrator for still algorithms

FinalizerClass

alias of FinalizerStills

InitializerClass

alias of InitializerStills

ProcessorClass

alias of dials.algorithms.integration.processor.ProcessorStills

class dials.algorithms.integration.integrator.IntegratorVolume(experiments, reflections, params)[source]

Bases: dials.algorithms.integration.image_integrator.ImageIntegrator

Volume integrator

class dials.algorithms.integration.integrator.Parameters[source]

Bases: object

A class to represent the integration parameters

class Filter[source]

Bases: object

Filter parameters

class Profile[source]

Bases: object

Profile parameters

class Validation[source]

Bases: object

static from_phil()[source]

Convert the phil parameters

class dials.algorithms.integration.integrator.ProfileModellerExecutor(experiments, profile_fitter)[source]

Bases: dials_algorithms_integration_integrator_ext.Executor

The class to do profile modelling calculations

data()[source]
Returns:the modeller
finalize()[source]

Finalize the processing

initialize(frame0, frame1, reflections)[source]

Initialise the processing for a job

Parameters:
  • frame0 – The first frame in the job
  • frame1 – The last frame in the job
  • reflections – The reflections that will be processed
process(frame, reflections)[source]

Process the data

Parameters:
  • frame – The frame being processed
  • reflections – The reflections to process
class dials.algorithms.integration.integrator.ProfileValidatorExecutor(experiments, profile_fitter)[source]

Bases: dials_algorithms_integration_integrator_ext.Executor

The class to do profile validation calculations

data()[source]
Returns:the modeller
finalize()[source]

Finalize the processing

initialize(frame0, frame1, reflections)[source]

Initialise the processing for a job

Parameters:
  • frame0 – The first frame in the job
  • frame1 – The last frame in the job
  • reflections – The reflections that will be processed
process(frame, reflections)[source]

Process the data

Parameters:
  • frame – The frame being processed
  • reflections – The reflections to process
dials.algorithms.integration.integrator.frame_hist(bbox, width=80, symbol='#', prefix='')[source]

A utility function to print a histogram of reflections on frames.

Parameters:
  • bbox – The bounding boxes
  • width – The width of each line
  • symbol – The histogram symbol
  • prefix – A string to prefix to each line
Returns:

The histogram string

dials.algorithms.integration.integrator.generate_phil_scope()[source]

Generate the integration phil scope.

Returns:The phil scope
dials.algorithms.integration.integrator.hist(data, width=80, symbol='#', prefix='')[source]

A utility function to print a histogram of reflections on frames.

Parameters:
  • data – The data to histogram
  • width – The number of characters in each line
  • symbol – The plot symbol
  • prefix – String to prefix to each line
Returns:

The histogram string

dials.algorithms.integration.integrator.nframes_hist(bbox, width=80, symbol='#', prefix='')[source]

A utility function to print a histogram of number of frames.

Parameters:
  • bbox – The bounding boxes
  • width – The width of each line
  • symbol – The histogram symbol
  • prefix – A string to prefix to each line
Returns:

The histogram string