casinotools.file_format.casino3 package

Subpackages

• casinotools.file_format.casino3.exported package
  • Submodules
    • casinotools.file_format.casino3.exported.energy module
    • casinotools.file_format.casino3.exported.trajectories module
      • ExportedTrajectories
  • Module contents
• casinotools.file_format.casino3.models package
  • Submodules
    • casinotools.file_format.casino3.models.cross_section_file module
  • Module contents
• casinotools.file_format.casino3.sample_shape package
  • Submodules
    • casinotools.file_format.casino3.sample_shape.shape_type module
      • get_string()
    • casinotools.file_format.casino3.sample_shape.sphere_shape module
      • SphereShape
  • Module contents
• casinotools.file_format.casino3.scan_points package
  • Submodules
    • casinotools.file_format.casino3.scan_points.base_pattern module
    • casinotools.file_format.casino3.scan_points.image_xz_pattern module
    • casinotools.file_format.casino3.scan_points.line_x_pattern module
    • casinotools.file_format.casino3.scan_points.lines_pattern module
    • casinotools.file_format.casino3.scan_points.rectangle_pattern module
    • casinotools.file_format.casino3.scan_points.scan_points_file module
  • Module contents

Submodules

• casinotools.file_format.casino3.diffused_energy_matrix module
• casinotools.file_format.casino3.element module
  • Element
    • Element._modify()
    • Element.get_atomic_fraction()
    • Element.get_atomic_number()
    • Element.get_atomic_weight_g_mol()
    • Element.get_composition()
    • Element.get_mass_density_g_cm3()
    • Element.get_radial_xray_distribution()
    • Element.get_repetition()
    • Element.get_symbol()
    • Element.get_total_xray_intensities()
    • Element.get_total_xray_intensity_by_line_type()
    • Element.get_weight_fraction()
    • Element.read()
    • Element.set_atomic_fraction()
    • Element.set_element()
    • Element.set_weight_fraction()
    • Element.write()
  • _compute_j()
  • compute_k()
  • get_atom()
• casinotools.file_format.casino3.energy_matrix module
• casinotools.file_format.casino3.file module
• casinotools.file_format.casino3.graph_data module
  • GraphData
    • GraphData._read_values()
    • GraphData.get_values()
    • GraphData.read()
  • index2pos()
• casinotools.file_format.casino3.intensity_image module
• casinotools.file_format.casino3.options_adf module
  • OptionsADF
    • OptionsADF.read()
    • OptionsADF.reset()
    • OptionsADF.write()
• casinotools.file_format.casino3.options_adv_back_set module
  • OptionsAdvBackSet
    • OptionsAdvBackSet.read()
    • OptionsAdvBackSet.reset()
    • OptionsAdvBackSet.write()
• casinotools.file_format.casino3.options_advanced_psfs_settings module
  • OptionsAdvancedPsfsSettings
    • OptionsAdvancedPsfsSettings.get_number_steps_x()
    • OptionsAdvancedPsfsSettings.get_number_steps_y()
    • OptionsAdvancedPsfsSettings.get_number_steps_z()
    • OptionsAdvancedPsfsSettings.get_psf_center_nm()
    • OptionsAdvancedPsfsSettings.get_use_scan_point_for_center()
    • OptionsAdvancedPsfsSettings.is_generating_psfs()
    • OptionsAdvancedPsfsSettings.read()
    • OptionsAdvancedPsfsSettings.reset()
    • OptionsAdvancedPsfsSettings.write()
• casinotools.file_format.casino3.options_dist module
  • OptionsDist
    • OptionsDist.get_deposited_energy_center_nm()
    • OptionsDist.get_deposited_energy_size_nm()
    • OptionsDist.read()
    • OptionsDist.reset()
    • OptionsDist.write()
• casinotools.file_format.casino3.options_energy_by_pos module
  • OptionsEnergyByPos
    • OptionsEnergyByPos.read()
    • OptionsEnergyByPos.reset()
    • OptionsEnergyByPos.write()
• casinotools.file_format.casino3.options_micro module
  • OptionsMicro
    • OptionsMicro.modify()
    • OptionsMicro.read()
    • OptionsMicro.reset()
    • OptionsMicro.write()
• casinotools.file_format.casino3.options_physic module
  • CrossSection
    • CrossSection.ELSEPA
    • CrossSection.MOTT_BROWNING
    • CrossSection.MOTT_DROUIN
    • CrossSection.MOTT_FILE
    • CrossSection.REIMER
    • CrossSection.RUTHERFORD
  • OptionsPhysic
    • OptionsPhysic.is_interpolation()
    • OptionsPhysic.is_monsel_settings()
    • OptionsPhysic.modify()
    • OptionsPhysic.read()
    • OptionsPhysic.reset()
    • OptionsPhysic.set_to_monsel_settings()
    • OptionsPhysic.write()
  • get_electron_elastic_cross_section_model_label()
• casinotools.file_format.casino3.options_xray module
  • OptionsXray
    • OptionsXray.read()
    • OptionsXray.reset()
    • OptionsXray.write()
• casinotools.file_format.casino3.point_spread_function_matrix module
  • PointSpreadFunctionMatrix
    • PointSpreadFunctionMatrix._read_values()
    • PointSpreadFunctionMatrix.get_data()
    • PointSpreadFunctionMatrix.get_number_points()
    • PointSpreadFunctionMatrix.get_number_points_x()
    • PointSpreadFunctionMatrix.get_number_points_y()
    • PointSpreadFunctionMatrix.get_number_points_z()
    • PointSpreadFunctionMatrix.read()
• casinotools.file_format.casino3.region module
  • Region
    • Region._check_atomic_fraction()
    • Region._check_weight_fraction()
    • Region._compute_atomic_fraction_elements()
    • Region._compute_mean_atomic_number()
    • Region._compute_mean_mass_density_g_cm3()
    • Region._compute_number_elements()
    • Region._generate_name()
    • Region._modify()
    • Region.add_element()
    • Region.export()
    • Region.get_composition()
    • Region.get_element()
    • Region.get_element_by_symbol()
    • Region.get_id()
    • Region.get_mean_atomic_number()
    • Region.get_mean_mass_density_g_cm3()
    • Region.get_name()
    • Region.get_number_elements()
    • Region.modify_name()
    • Region.read()
    • Region.remove_all_elements()
    • Region.update()
    • Region.write()
• casinotools.file_format.casino3.region_intensity_info module
  • RegionIntensityInfo
    • RegionIntensityInfo.get_energy_intensity()
    • RegionIntensityInfo.get_normalized_energy_intensity()
    • RegionIntensityInfo.read()
• casinotools.file_format.casino3.region_options module
  • RegionOptions
    • RegionOptions.get_region()
    • RegionOptions.read()
    • RegionOptions.write()
• casinotools.file_format.casino3.sample module
  • Sample
    • Sample._export_header()
    • Sample._export_region_data()
    • Sample._export_sample_data()
    • Sample._export_sample_objects()
    • Sample._export_substrate()
    • Sample._export_version()
    • Sample._read_3131()
    • Sample.add_region()
    • Sample.add_sample_object()
    • Sample.add_sample_object_with_id()
    • Sample.export()
    • Sample.get_first_sphere_shape()
    • Sample.get_plane_shapes()
    • Sample.get_regions()
    • Sample.get_rotation_y_deg()
    • Sample.get_rotation_z_deg()
    • Sample.get_shapes()
    • Sample.get_version()
    • Sample.modify_rotation_y_deg()
    • Sample.modify_rotation_z_deg()
    • Sample.read()
    • Sample.set_rotation_y_deg()
    • Sample.set_rotation_z_deg()
    • Sample.write()
  • ShapeError
• casinotools.file_format.casino3.sample_object module
  • SampleObject
    • SampleObject._export_color()
    • SampleObject._export_name()
    • SampleObject._export_region_name()
    • SampleObject._export_rotation()
    • SampleObject._export_scale()
    • SampleObject._export_translation()
    • SampleObject._export_type()
    • SampleObject._export_version()
    • SampleObject.export()
    • SampleObject.get_name()
    • SampleObject.get_scale_nm()
    • SampleObject.get_translation_nm()
    • SampleObject.get_type()
    • SampleObject.get_version()
    • SampleObject.modify()
    • SampleObject.modify_position_z()
    • SampleObject.read()
• casinotools.file_format.casino3.sample_object_factory module
  • BoxShape
  • ConeShape
    • ConeShape.read()
  • CylindreShape
    • CylindreShape.read()
  • MeshObject
    • MeshObject.read()
  • PlaneShape
    • PlaneShape.read()
  • RoundedRectangleShape
    • RoundedRectangleShape.read()
  • TruncatedPyramidShape
    • TruncatedPyramidShape.read()
  • create_object_from_type()
• casinotools.file_format.casino3.sample_reader module
  • SampleReader
    • SampleReader.get_sample()
    • SampleReader.read()
• casinotools.file_format.casino3.sample_substrate module
  • Edge
    • Edge.read()
  • SampleSubstrate
    • SampleSubstrate.export()
    • SampleSubstrate.read()
• casinotools.file_format.casino3.sample_tree module
  • SampleTree
    • SampleTree.export()
    • SampleTree.read()
• casinotools.file_format.casino3.scan_point_positions module
  • ScanPointPositions
    • ScanPointPositions.add_position()
    • ScanPointPositions.export()
    • ScanPointPositions.get_number_points()
    • ScanPointPositions.get_positions()
    • ScanPointPositions.read()
    • ScanPointPositions.reset()
• casinotools.file_format.casino3.scan_point_results module
• casinotools.file_format.casino3.simulation_data module
• casinotools.file_format.casino3.simulation_options module
  • SimulationOptions
    • SimulationOptions.export()
    • SimulationOptions.get_options_advanced_psfs_settings()
    • SimulationOptions.get_options_distributions()
    • SimulationOptions.read()
    • SimulationOptions.write()
• casinotools.file_format.casino3.simulation_results module
• casinotools.file_format.casino3.trajectory module
  • Trajectory
    • Trajectory._is_type()
    • Trajectory._read_header()
    • Trajectory._read_header_fast()
    • Trajectory._read_number_scattering_events()
    • Trajectory._read_number_scattering_events_fast()
    • Trajectory._read_scattering_events()
    • Trajectory._read_scattering_events_optimized()
    • Trajectory._read_scattering_events_original()
    • Trajectory.delete_all_trajectory_collisions()
    • Trajectory.get_number_scattering_events()
    • Trajectory.get_scattering_event()
    • Trajectory.get_scattering_events()
    • Trajectory.get_scattering_events_by_type()
    • Trajectory.get_type()
    • Trajectory.get_type_name()
    • Trajectory.get_version()
    • Trajectory.is_type_backscattered()
    • Trajectory.is_type_detected()
    • Trajectory.is_type_displayed()
    • Trajectory.is_type_none()
    • Trajectory.is_type_secondary()
    • Trajectory.is_type_transmitted()
    • Trajectory.read()
• casinotools.file_format.casino3.trajectory_collision module
  • TrajectoryCollision
    • TrajectoryCollision._read_optimized()
    • TrajectoryCollision._read_original()
    • TrajectoryCollision.get_collision_type()
    • TrajectoryCollision.get_collision_type_name()
    • TrajectoryCollision.get_energy_keV()
    • TrajectoryCollision.get_position_nm()
    • TrajectoryCollision.get_radius_xy_nm()
    • TrajectoryCollision.get_region_id()
    • TrajectoryCollision.get_x_nm()
    • TrajectoryCollision.get_y_nm()
    • TrajectoryCollision.get_z_nm()
    • TrajectoryCollision.read()
    • TrajectoryCollision.set_values()
  • get_size_scattering_event()
• casinotools.file_format.casino3.transmitted_angles module
• casinotools.file_format.casino3.triangle module
  • Triangle
    • Triangle.export()
    • Triangle.read()
• casinotools.file_format.casino3.vector module
  • Vector
• casinotools.file_format.casino3.version module
  • SIM_OPTIONS_VERSION_3_1_2_2
  • SIM_OPTIONS_VERSION_3_1_2_5
  • SIM_OPTIONS_VERSION_3_1_3_1
  • SIM_OPTIONS_VERSION_3_1_3_40
  • SIM_OPTIONS_VERSION_3_1_3_5
  • SIM_OPTIONS_VERSION_3_1_3_70
  • SIM_OPTIONS_VERSION_3_1_3_9
  • SIM_OPTIONS_VERSION_3_1_4_0
  • SIM_OPTIONS_VERSION_3_1_4_3
  • SIM_OPTIONS_VERSION_3_1_4_4
  • SIM_OPTIONS_VERSION_3_1_4_5
  • SIM_OPTIONS_VERSION_3_1_4_6
  • SIM_OPTIONS_VERSION_3_1_4_60
  • SIM_OPTIONS_VERSION_3_1_4_7
  • SIM_OPTIONS_VERSION_3_1_4_71
  • SIM_OPTIONS_VERSION_3_1_4_72
  • SIM_OPTIONS_VERSION_3_1_4_73
  • SIM_OPTIONS_VERSION_3_1_4_74
  • SIM_OPTIONS_VERSION_3_1_4_80
  • SIM_OPTIONS_VERSION_3_1_4_96
  • SIM_OPTIONS_VERSION_3_1_5_1
  • SIM_OPTIONS_VERSION_3_1_5_10
  • SIM_OPTIONS_VERSION_3_1_5_12
  • SIM_OPTIONS_VERSION_3_1_5_20
  • SIM_OPTIONS_VERSION_3_1_5_21
  • SIM_OPTIONS_VERSION_3_1_5_22
  • SIM_OPTIONS_VERSION_3_1_5_4
  • SIM_OPTIONS_VERSION_3_1_5_5
  • SIM_OPTIONS_VERSION_3_1_7_0
  • SIM_OPTIONS_VERSION_3_1_7_1
  • SIM_OPTIONS_VERSION_3_1_7_2
  • SIM_OPTIONS_VERSION_3_1_7_3
  • SIM_OPTIONS_VERSION_3_1_8_1
  • SIM_OPTIONS_VERSION_3_1_8_2
  • SIM_OPTIONS_VERSION_3_1_9_0
  • SIM_OPTIONS_VERSION_3_1__
  • SIM_OPTIONS_VERSION_3_2_0_0
  • SIM_OPTIONS_VERSION_3_2_0_1
  • SIM_OPTIONS_VERSION_3_2_0_2
  • SIM_OPTIONS_VERSION_3_2_0_3
  • SIM_OPTIONS_VERSION_3_3_0_0
  • SIM_OPTIONS_VERSION_3_3_0_4
  • is_version_casino3()

Module contents

Description