Scipion

Set up

  • Installing Scipion
  • Scipion configuration
  • Host configuration
  • Troubleshooting

User documentation

  • Graphical interface manuals
  • Image processing resources
  • Tutorials
  • Processing How To’s

Facilities

  • On-the-fly processing
  • Streaming workflows
  • Summary Reports

Developer documentation

  • Developers Page

API Documentation

  • Scipion API
  • Plugins API
    • xmipp3 package
      • xmipp3.convert package
      • xmipp3.legacy package
      • xmipp3.protocols package
        • xmipp3.protocols.protocol_preprocess package
        • xmipp3.protocols.protocol_projmatch package
        • xmipp3.protocols.protocol_alignPCA_2D module
        • xmipp3.protocols.protocol_align_volume module
        • xmipp3.protocols.protocol_align_volume_and_particles module
        • xmipp3.protocols.protocol_analyze_local_ctf module
        • xmipp3.protocols.protocol_angular_graph_consistency module
        • xmipp3.protocols.protocol_apply_alignment module
        • xmipp3.protocols.protocol_apply_tilt_to_ctf module
        • xmipp3.protocols.protocol_apply_transformation_matrix module
        • xmipp3.protocols.protocol_apply_zernike3d module
        • xmipp3.protocols.protocol_assignment_tilt_pair module
        • xmipp3.protocols.protocol_break_symmetry module
        • xmipp3.protocols.protocol_center_particles module
        • xmipp3.protocols.protocol_cl2d module
        • xmipp3.protocols.protocol_cl2d_align module
        • xmipp3.protocols.protocol_cl2d_clustering module
        • xmipp3.protocols.protocol_classes_2d_mapping module
        • xmipp3.protocols.protocol_compare_angles module
        • xmipp3.protocols.protocol_compare_reprojections module
        • xmipp3.protocols.protocol_compute_likelihood module
        • xmipp3.protocols.protocol_consensus_classes module
        • xmipp3.protocols.protocol_consensus_local_ctf module
        • xmipp3.protocols.protocol_convert_pdb module
        • xmipp3.protocols.protocol_core_analysis module
        • xmipp3.protocols.protocol_create_gallery module
        • xmipp3.protocols.protocol_ctf_consensus module
        • xmipp3.protocols.protocol_ctf_correct_phase module
        • xmipp3.protocols.protocol_ctf_correct_wiener2d module
        • xmipp3.protocols.protocol_ctf_defocus_group module
        • xmipp3.protocols.protocol_ctf_micrographs module
        • xmipp3.protocols.protocol_deep_hand module
        • xmipp3.protocols.protocol_deep_micrograph_screen module
        • xmipp3.protocols.protocol_denoise_particles module
        • xmipp3.protocols.protocol_eliminate_empty_images module
        • xmipp3.protocols.protocol_extract_asymmetric_unit module
        • xmipp3.protocols.protocol_extract_particles module
        • xmipp3.protocols.protocol_extract_particles_pairs module
        • xmipp3.protocols.protocol_flexalign module
        • xmipp3.protocols.protocol_generate_reprojections module
        • xmipp3.protocols.protocol_helical_parameters module
        • xmipp3.protocols.protocol_kerdensom module
        • xmipp3.protocols.protocol_local_ctf module
        • xmipp3.protocols.protocol_mics_defocus_balancer module
        • xmipp3.protocols.protocol_ml2d module
        • xmipp3.protocols.protocol_movie_alignment_consensus module
        • xmipp3.protocols.protocol_movie_dose_analysis module
        • xmipp3.protocols.protocol_movie_gain module
        • xmipp3.protocols.protocol_movie_max_shift module
        • xmipp3.protocols.protocol_movie_split_frames module
        • xmipp3.protocols.protocol_multiple_fscs module
        • xmipp3.protocols.protocol_multireference_alignability module
        • xmipp3.protocols.protocol_normalize_strain module
        • xmipp3.protocols.protocol_particle_pick module
        • xmipp3.protocols.protocol_particle_pick_automatic module
        • xmipp3.protocols.protocol_particle_pick_consensus module
        • xmipp3.protocols.protocol_particle_pick_pairs module
        • xmipp3.protocols.protocol_particle_pick_remove_duplicates module
        • xmipp3.protocols.protocol_phantom_create module
        • xmipp3.protocols.protocol_pick_noise module
        • xmipp3.protocols.protocol_postProcessing_deepPostProcessing module
        • xmipp3.protocols.protocol_preprocess_micrographs module
        • xmipp3.protocols.protocol_random_conical_tilt module
        • xmipp3.protocols.protocol_ransac module
        • xmipp3.protocols.protocol_reconstruct_fourier module
        • xmipp3.protocols.protocol_reconstruct_highres module
        • xmipp3.protocols.protocol_reconstruct_significant module
        • xmipp3.protocols.protocol_reconstruct_swarm module
        • xmipp3.protocols.protocol_resolution3d module
        • xmipp3.protocols.protocol_resolution_bfactor module
        • xmipp3.protocols.protocol_resolution_deepres module
        • xmipp3.protocols.protocol_resolution_directional module
        • xmipp3.protocols.protocol_resolution_fso module
        • xmipp3.protocols.protocol_resolution_monogenic_signal module
        • xmipp3.protocols.protocol_rotate_volume module
        • xmipp3.protocols.protocol_rotational_symmetry module
        • xmipp3.protocols.protocol_screen_deepConsensus module
        • xmipp3.protocols.protocol_screen_particles module
        • xmipp3.protocols.protocol_shift_particles module
        • xmipp3.protocols.protocol_shift_volume module
        • xmipp3.protocols.protocol_simulate_ctf module
        • xmipp3.protocols.protocol_structure_map module
        • xmipp3.protocols.protocol_structure_map_zernike3d module
        • xmipp3.protocols.protocol_subtract_projection module
        • xmipp3.protocols.protocol_tilt_analysis module
        • xmipp3.protocols.protocol_trigger_data module
        • xmipp3.protocols.protocol_validate_fscq module
        • xmipp3.protocols.protocol_validate_nontilt module
        • xmipp3.protocols.protocol_validate_overfitting module
        • xmipp3.protocols.protocol_volume_adjust_sub module
        • xmipp3.protocols.protocol_volume_consensus module
        • xmipp3.protocols.protocol_volume_deform_zernike3d module
        • xmipp3.protocols.protocol_volume_local_adjust module
        • xmipp3.protocols.protocol_volume_local_sharpening module
        • xmipp3.protocols.protocol_volume_strain module
        • xmipp3.protocols.protocol_write_testC module
        • xmipp3.protocols.protocol_write_testP module
      • xmipp3.viewers package
      • xmipp3.base module
      • xmipp3.bibtex module
      • xmipp3.checkProtocolsConf module
      • xmipp3.constants module
      • xmipp3.logParser module
      • xmipp3.programs module
      • xmipp3.protocolsCollectInfo module
      • xmipp3.utils module
      • xmipp3.version module
      • xmipp3.wizards module
  • Xmipp API

Get in touch

  • Contact Us

Licences

  • Licenses
Scipion
  • »
  • Plugins API »
  • xmipp3 package »
  • xmipp3.protocols package »
  • xmipp3.protocols.protocol_create_gallery module
  • View page source

xmipp3.protocols.protocol_create_gallery module

class xmipp3.protocols.protocol_create_gallery.XmippProtCreateGallery(**kwargs)[source]

Bases: ProtAnalysis3D

Create a gallery of projections from a volume. This gallery of projections may help to understand the images observed in the microscope.

AI Generated:

## Overview

The Create Gallery protocol generates a systematic set of 2D projections from a 3D volume. These projections simulate how the structure would appear from different viewing directions, providing a direct link between the reconstructed volume and the particle images observed in the microscope.

For biological users, this protocol is especially useful for interpreting 2D class averages, validating reconstructions, or gaining intuition about the structural features of a macromolecule. By comparing experimental images with the generated projections, one can assess whether the reconstructed volume is consistent with the data and whether certain views are over- or under-represented.

This type of gallery is also commonly used for visualization, teaching, and figure preparation.

## Inputs and General Workflow

The protocol requires a 3D volume as input. From this volume, it computes projections over a range of orientations defined by the user.

The angular sampling is controlled by specifying ranges for rotational (in-plane rotation) and tilt (out-of-plane angle). The protocol systematically samples these angles to generate a grid of projections covering the orientation space.

If symmetry is present in the structure, it can be specified so that redundant views are avoided and the gallery reflects the true symmetry of the particle.

The output is a set of 2D images representing projections of the volume from different directions, which can be directly compared with experimental particle images or class averages.

## Angular Sampling: Exploring the Orientation Space

The most important parameters for biological interpretation are the angular ranges and steps.

The rotational angle typically spans 0 to 360 degrees and controls rotation around the projection axis. The tilt angle determines the viewing direction, where 0 degrees corresponds to a top view and 90 degrees to a side view.

The step size defines how densely the orientation space is sampled. Smaller steps produce a more detailed and complete gallery but increase computational cost and the number of generated images.

From a practical point of view, coarse sampling is often sufficient for e xploratory analysis or quick comparisons, while finer sampling is useful when trying to match specific experimental views or when preparing publication-quality figures.

## Symmetry Considerations

The symmetry group defines how orientations are reduced according to the intrinsic symmetry of the structure.

For asymmetric particles, the default c1 symmetry should be used. For symmetric assemblies (for example cyclic or dihedral symmetries), specifying the correct symmetry ensures that equivalent orientations are not redundantly sampled.

Biologically, this is important because symmetry determines which views are unique. Using the wrong symmetry may lead to misleading interpretations when comparing projections to experimental data.

## Projection Methods

The protocol offers several methods to compute projections, which mainly differ in computational approach and numerical properties.

The Fourier method is the default and most commonly used option. It computes projections using the central slice theorem in Fourier space and provides a good balance between accuracy and efficiency. For most biological applications, this is the recommended choice.

The Real space method performs projections by integrating along rays through the volume. It is conceptually straightforward but generally slower.

The Shears method is an alternative real-space approach that can be efficient in certain situations but is less commonly used in routine

workflows.

In most cases, users do not need to change the default method unless there is a specific reason to explore numerical differences.

## Advanced Parameters

Several advanced parameters are available, mainly affecting the Fourier-based projection.

The padding factor controls how much the volume is expanded before projection. Increasing padding can improve interpolation accuracy but also increases computational cost.

The maximum frequency defines the highest spatial frequency considered in the projection. Limiting this value can reduce noise or numerical artifacts but may also remove high-resolution information.

The interpolation method determines how values are estimated between sampled points. Higher-order interpolation (such as cubic B-spline) typically produces smoother and more accurate projections.

Another parameter, shift sigma, introduces small random shifts in the projections. While not commonly used in standard workflows, it can be helpful when simulating more realistic image variability.

For most biological use cases, the default values of these parameters are appropriate.

## Outputs and Their Interpretation

The protocol produces a set of 2D images corresponding to projections of the input volume. Each image is associated with a specific orientation, and together they form a gallery covering the sampled angular space.

These projections can be directly compared with experimental particle images or 2D class averages. Good agreement between projections and experimental data supports the validity of the reconstructed volume.

From a biological perspective, the gallery helps to: * Identify characteristic views of the structure * Understand how structural features appear in projection * Detect missing or underrepresented orientations in the data

## Practical Recommendations

A typical use of this protocol is to generate projections after obtaining a 3D reconstruction and compare them visually with 2D class averages. This helps verify that the reconstruction explains the observed data.

For exploratory analysis, moderate angular steps (for example 5–10 degrees) are usually sufficient. For more detailed comparisons or figure preparation, smaller steps may be beneficial.

If the structure has known symmetry, it is important to specify it correctly to avoid redundant projections and to obtain a biologically meaningful gallery.

In most cases, the default Fourier projection method with standard parameters provides reliable results without further tuning.

## Final Perspective

The Create Gallery protocol is a simple but powerful tool for connecting 3D structures with their 2D experimental observations. By visualizing how a volume appears from different orientations, it provides valuable intuition and serves as a practical validation step in cryo-EM workflows.

For biological users, it is often one of the most direct ways to assess whether a reconstruction truly reflects the underlying data.

INTERP_METHOD_BSPLINE = 2
INTERP_METHOD_LINEAR = 1
INTERP_METHOD_NEAREST = 0
METHOD_FOURIER = 2
METHOD_REAL_SPACE = 0
METHOD_SHEARS = 1
PARAM_FILE_NAME = 'projectionParameters.xmd'
copyInput()[source]
createGallery()[source]
createOutput()[source]
interpMethodsDict = {0: 'nearest', 1: 'linear', 2: 'bspline'}
Previous Next

© Copyright 2022, Scipion team.

Built with Sphinx using a theme provided by Read the Docs.