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.algorithms.indexing

class dials.algorithms.indexing.indexer.Solution(**keyword_arguments)

Bases: libtbx.group_args

class dials.algorithms.indexing.indexer.SolutionTrackerFilter(check_doubled_cell=True, likelihood_cutoff=0.8, volume_cutoff=1.25, n_indexed_cutoff=0.9)

Bases: object

append(item)

best_solution()

filter_by_likelihood(solutions)

filter_by_n_indexed(solutions, n_indexed_cutoff=None)

filter_by_volume(solutions)

update_analysis()

class dials.algorithms.indexing.indexer.SolutionTrackerWeighted(power=2, volume_weight=1, n_indexed_weight=1, rmsd_weight=1)

Bases: object

append(item)

best_solution()

score_by_fraction_indexed(reverse=False)

score_by_rmsd_xy(reverse=False)

score_by_rmsd_z(reverse=False)

score_by_volume(reverse=False)

solution_scores()

dials.algorithms.indexing.indexer.apply_hkl_offset(indices, offset)

class dials.algorithms.indexing.indexer.basis_vector_minimser(reciprocal_lattice_points, vector, lbfgs_termination_params=None, lbfgs_core_params=<scitbx.lbfgs.core_parameters object>)

Bases: object

callback_after_step(minimizer)

compute_functional_and_gradients()

class dials.algorithms.indexing.indexer.basis_vector_target(reciprocal_lattice_points)

Bases: object

compute_functional_and_gradients(vector)

dials.algorithms.indexing.indexer.detect_non_primitive_basis(miller_indices, threshold=0.9)

dials.algorithms.indexing.indexer.filter_doubled_cell(solutions)

dials.algorithms.indexing.indexer.filter_reflections_by_scan_range(reflections, scan_range)

dials.algorithms.indexing.indexer.hist_outline(hist)

class dials.algorithms.indexing.indexer.indexer_base(reflections, imagesets, params=None)

Bases: object

apply_symmetry(crystal_model, target_space_group)

static calculate_entering_flags(reflections, beam, goniometer)

choose_best_orientation_matrix(candidate_orientation_matrices)

correct_non_primitive_basis(experiments, reflections, threshold)

debug_plot_candidate_basis_vectors()

debug_show_candidate_basis_vectors()

debug_write_ccp4_map(map_data, file_name)

debug_write_reciprocal_lattice_points_as_pdb(file_name='reciprocal_lattice.pdb')

export_as_json(experiments, file_name='experiments.json', compact=False)

export_reflections(reflections, file_name='reflections.pickle')

filter_reflections_by_scan_range()

find_candidate_orientation_matrices(candidate_basis_vectors)

find_lattices()

find_max_cell()

static from_parameters(reflections, imagesets, known_crystal_models=None, params=None)

index()

index_reflections(experiments, reflections)

static map_centroids_to_reciprocal_space(spots_mm, detector, beam, goniometer, calculated=False)

Map mm/radian spot centroids to reciprocal space.

Used to convert spot centroids provided in mm/radian units to reciprocal space as required for indexing. Adds the column ‘rlp’ to the reflection table, which contains a flex.vec3_double array of the reciprocal lattice vectors.

Parameters:

• spots_mm (dials.array_family.flex.reflection_table) – a reflection table containing the column ‘xyzobs.mm.value’
• detector (dxtbx.model.detector.Detector) – a dxtbx detector object
• beam (dxtbx.model.beam.Beam) – a dxtbx beam object
• goniometer (dxtbx.model.goniometer.Goniometer) – a dxtbx goniometer object. May be None, e.g. for a still image

static map_spots_pixel_to_mm_rad(spots, detector, scan)

Map spot centroids from pixel/image number to mm/radian.

Used to convert spot centroids coming from e.g. dials.find_spots which are in pixel/image number units to mm/radian units as required for indexing and refinement.

Parameters:

• spots (dials.array_family.flex.reflection_table) – a reflection table containing the columns ‘xyzobs.px.value’, ‘xyzobs.px.variance’ and ‘panel’
• detector (dxtbx.model.detector.Detector) – a dxtbx detector object
• scan (dxtbx.model.scan.Scan) – a dxtbx scan object. May be None, e.g. for a still image

Returns:

A copy of the input reflection table containing the additional keys ‘xyzobs.mm.value’ and ‘xyzobs.mm.variance’

Return type:

dials.array_family.flex.reflection_table

refine(experiments, reflections)

setup_indexing()

show_experiments(experiments, reflections, d_min=None)

dials.algorithms.indexing.indexer.is_approximate_integer_multiple(vec_a, vec_b, relative_tolerance=0.2, angular_tolerance=5.0)

dials.algorithms.indexing.indexer.optimise_basis_vectors(reciprocal_lattice_points, vectors)

dials.algorithms.indexing.indexer.plot_centroid_weights_histograms(reflections, n_slots=50)

dials.algorithms.indexing.indexer.reject_weight_outliers_selection(reflections, sigma_cutoff=5)

class dials.algorithms.indexing.indexer.vector_group

Bases: object

append(vector, length, volume)

compute_mean()

mean()

dials.algorithms.indexing.fft3d.clean_3d(dirty_beam, dirty_map, n_peaks, gamma=1)

class dials.algorithms.indexing.fft3d.indexer_fft3d(reflections, imagesets, params)

Bases: dials.algorithms.indexing.indexer.indexer_base

cluster_analysis_dbscan(vectors)

cluster_analysis_hcluster(vectors)

debug_plot_clusters(vectors, labels, min_cluster_size=1)

fft()

find_basis_vector_combinations_cluster_analysis()

find_candidate_basis_vectors()

find_lattices()

find_peaks()

find_peaks_clean()

map_centroids_to_reciprocal_space_grid()

optimise_peaks(peaks, reciprocal_lattice_points)

dials.algorithms.indexing.fft3d.sampling_volume_map(data, angle_range, beam_vector, rotation_axis, rl_grid_spacing, d_min, b_iso)

class dials.algorithms.indexing.fft1d.indexer_fft1d(reflections, imagesets, params)

Bases: dials.algorithms.indexing.indexer.indexer_base

candidate_basis_vectors_fft1d(reciprocal_lattice_vectors, params, max_cell=None)

find_candidate_basis_vectors()

find_lattices()

class dials.algorithms.indexing.real_space_grid_search.indexer_real_space_grid_search(reflections, imagesets, params)

Bases: dials.algorithms.indexing.indexer.indexer_base

find_lattices()

real_space_grid_search()

dials.algorithms.indexing.compare_orientation_matrices.difference_rotation_matrix_axis_angle(crystal_a, crystal_b, target_angle=0)

dials.algorithms.indexing.compare_orientation_matrices.rotation_matrix_differences(crystal_models, miller_indices=None, comparison='pairwise')

dials.algorithms.indexing.compare_orientation_matrices.show_rotation_matrix_differences(crystal_models, out=None, miller_indices=None, comparison='pairwise')

class dials.algorithms.indexing.symmetry.bravais_setting(other)

Bases: rstbx.symmetry.subgroup.MetricSubgroup

dials.algorithms.indexing.symmetry.dials_crystal_from_orientation(crystal_orientation, space_group)

dials.algorithms.indexing.symmetry.find_matching_symmetry(unit_cell, target_space_group, max_delta=5)

dials.algorithms.indexing.symmetry.identify_likely_solutions(all_solutions)

dials.algorithms.indexing.symmetry.metric_supergroup(group)

dials.algorithms.indexing.symmetry.refine_subgroup(args)

dials.algorithms.indexing.symmetry.refined_settings_factory_from_refined_triclinic(params, experiments, reflections, i_setting=None, lepage_max_delta=5.0, nproc=1, refiner_verbosity=0)

class dials.algorithms.indexing.symmetry.refined_settings_list

Bases: list

as_dict()

labelit_printout(out=None)

supergroup()

triclinic()

dials.algorithms.indexing.refinement.debug_plot_residuals(refiner, inlier_sel=None)

dials.algorithms.indexing.refinement.refine(params, reflections, experiments, verbosity=0, debug_plots=False)