API reference

Subpackages

• integrator.app package
  • Submodules
    • integrator.app.bootstrap module
      • parse_sections()
      • bootstrap()
    • integrator.app.check_datasets module
      • frame_print()
      • check_datasets_cli()
      • check_integrated_datasets()
    • integrator.app.integrate_mp module
      • integrate_mp_cli()
      • generate_bash_script()
    • integrator.app.integrate_mp_worker module
      • integrate_mp_worker_cli()
    • integrator.app.integrator_config module
    • integrator.app.pack module
    • integrator.app.utils module
      • get_computations_config()
      • get_ai_config()
      • browse_datasets_wildcard()
      • get_output_folders()
      • get_distributed_integrator_params()
    • integrator.app.validators module
      • convert_to_tuple_of_floats()
      • check_writeable_output()
  • Module contents

Submodules

• integrator.hdf5 module
  • get_h5obj_value()
  • get_string()
  • format_time()
  • get_datetime()
  • is_same_config()
  • guess_detector_name()
• integrator.integrator module
  • AIConfiguration
    • AIConfiguration.n_pts
    • AIConfiguration.unit
    • AIConfiguration.polarization_factor
    • AIConfiguration.correct_solid_angle
    • AIConfiguration.detector
    • AIConfiguration.poni_file
    • AIConfiguration.mask_file
    • AIConfiguration.flatfield_file
    • AIConfiguration.dark_file
    • AIConfiguration.error_model
    • AIConfiguration.azimuthal_range
    • AIConfiguration.radial_range
    • AIConfiguration.ai_method
    • AIConfiguration.trim_method
    • AIConfiguration.trim_n_pts
    • AIConfiguration.trim_bounds
    • AIConfiguration.do_stack_mean
    • AIConfiguration.pixel_splitting
    • AIConfiguration.average_xy
  • create_azimuthal_integrator()
  • StackIntegrator
    • StackIntegrator.get_current_config()
    • StackIntegrator.integrate_image()
    • StackIntegrator.process_data()
  • result_already_exists()
• integrator.monitoring module
  • format_dataurl_to_scan()
  • check_progress()
  • do_in_thread()
  • ScansIntegrationMonitor
    • ScansIntegrationMonitor.stop()
    • ScansIntegrationMonitor.stopped()
  • monitor_scans()
• integrator.multiproc_integration module
  • ComputationResources
    • ComputationResources.n_multi_worker
    • ComputationResources.n_workers_per_multiworker
    • ComputationResources.n_threads_per_worker
    • ComputationResources.memory
    • ComputationResources.walltime
    • ComputationResources.queue
  • worker_scan()
  • MultiprocIntegrator
    • MultiprocIntegrator.process_scans()
    • MultiprocIntegrator.close_processes()
• integrator.old_multiproc_integration module
• integrator.processconfig module
  • get_partial_output_file()
  • ProcessingConfig
    • ProcessingConfig.build_tasks_distribution()
    • ProcessingConfig.dump_tasks_to_disk()
  • load_work_config()
• integrator.slurm module
  • SlurmResourcesConfiguration
    • SlurmResourcesConfiguration.partition
    • SlurmResourcesConfiguration.time
    • SlurmResourcesConfiguration.memory
    • SlurmResourcesConfiguration.cpus_per_task
    • SlurmResourcesConfiguration.gres
    • SlurmResourcesConfiguration.cores_per_socket
    • SlurmResourcesConfiguration.format_cli()
  • submit_bash_script()
• integrator.templates module
• integrator.utils module
  • PeriodicAction
    • PeriodicAction.start()
    • PeriodicAction.stop()
    • PeriodicAction.cancel()
  • PatchLogLevel
  • make_azims()
  • parse_poni_file()
  • check_poni_file_detector()
  • get_h5_config_from_pyfai()
  • create_output_masterfile()
  • browse_virtual_sources()
  • retry_create_masterfile()
  • retry_n_times()
  • walltime_to_seconds()
  • whoami()
  • get_identifier()
  • partition_list()
  • files_relative_paths()
  • get_worker_threads_affinity()
  • get_opencl_devices()
  • safe_format()
  • exec_shell_command()
  • get_number_of_available_gpus()
  • file_mode_to_octal()
  • get_additional_metadata()
• integrator.watcherv0 module
• integrator.writer module
  • collect_results_from_files()
  • create_output_file_id15a()
  • create_output_file()
  • watch_scans_and_create_output_files()
  • submit_repack_output()
  • repack_output_file()

Module contents