pymicro Package¶
pymicro Package¶
A package to work with material microstructures and 3d data sets
- pymicro.__init__.get_cache_dir(data_home=None)¶
- pymicro.__init__.download_data(fname, cache=True)¶
- pymicro.__init__.dowload_datadir()¶
Download the data directory
- Returns:
pl.Path: the path to the data directory
- pymicro.__init__.get_examples_data_dir(download_if_required=True) Path¶
Get the path to the examples data directory
- Returns:
pl.Path: the path to the examples data directory
Subpackages¶
- apps Package
- core Package
samplesModuleSampleDataSampleData.__init__()SampleData.__del__()SampleData.__repr__()SampleData.__contains__()SampleData.__getitem__()SampleData.__getattribute__()SampleData.minimal_data_model()SampleData.print_xdmf()SampleData.write_xdmf()SampleData.print_dataset_content()SampleData.print_group_content()SampleData.print_node_info()SampleData.print_node_attributes()SampleData.print_node_compression_info()SampleData.print_data_arrays_info()SampleData.print_grids_info()SampleData.print_index()SampleData.sync()SampleData.pause_for_visualization()SampleData.switch_verbosity()SampleData.add_mesh()SampleData.add_mesh_from_image()SampleData.add_image()SampleData.add_image_from_field()SampleData.add_field_time()SampleData.add_grid_time()SampleData.add_group()SampleData.add_field()SampleData.add_data_array()SampleData.add_table()SampleData.add_tablecols()SampleData.add_string_array()SampleData.append_string_array()SampleData.append_table()SampleData.add_attributes()SampleData.add_alias()SampleData.add_to_index()SampleData.compute_mesh_elements_normals()SampleData.get_indexname_from_path()SampleData.get_mesh()SampleData.get_mesh_from_image()SampleData.get_mesh_nodes()SampleData.get_mesh_nodesID()SampleData.get_mesh_node_tag()SampleData.get_mesh_node_tag_coordinates()SampleData.get_mesh_xdmf_connectivity()SampleData.get_mesh_elements()SampleData.get_mesh_elem_types_and_number()SampleData.get_mesh_elem_tag()SampleData.get_mesh_elem_tags_names()SampleData.get_mesh_elem_tag_connectivity()SampleData.get_mesh_node_tags_names()SampleData.get_image()SampleData.get_tablecol()SampleData.get_table_description()SampleData.get_grid_field_list()SampleData.get_field()SampleData.get_node()SampleData.get_dic_from_attributes()SampleData.get_attribute()SampleData.get_file_disk_size()SampleData.get_node_disk_size()SampleData.get_sample_name()SampleData.set_sample_name()SampleData.get_description()SampleData.set_description()SampleData.set_new_indexname()SampleData.set_voxel_size()SampleData.set_origin()SampleData.set_tablecol()SampleData.set_nodes_compression_chunkshape()SampleData.set_chunkshape_and_compression()SampleData.set_verbosity()SampleData.remove_attribute()SampleData.remove_attributes()SampleData.rename_node()SampleData.remove_node()SampleData.resample_image_group()SampleData.repack_h5file()SampleData.copy_sample()SampleData.create_elset_ids_field()SampleData.__annotations__
- crystal Package
- Subpackages
latticeModuleCrystalCrystallinePhaseCrystallinePhase.__init__()CrystallinePhase.get_lattice()CrystallinePhase.set_lattice()CrystallinePhase.set_name()CrystallinePhase.get_symmetry()CrystallinePhase.set_elastic_constants()CrystallinePhase.to_dict()CrystallinePhase.stiffness_matrix()CrystallinePhase.orthotropic_constants()CrystallinePhase.from_dict()
SymmetrySymmetry.cubicSymmetry.hexagonalSymmetry.orthorhombicSymmetry.tetragonalSymmetry.trigonalSymmetry.monoclinicSymmetry.triclinicSymmetry.from_string()Symmetry.to_string()Symmetry.from_dream3d()Symmetry.from_space_group()Symmetry.from_tsl()Symmetry.to_tsl()Symmetry.symmetry_operators()Symmetry.move_vector_to_FZ()Symmetry.move_rotation_to_FZ()Symmetry.lattice_parameters_number()Symmetry.elastic_constants_number()Symmetry.stiffness_matrix()Symmetry.orthotropic_constants_from_stiffness()
LatticeLattice.__init__()Lattice.reciprocal_lattice()Lattice.matrixLattice.get_symmetry()Lattice.symmetry()Lattice.get_lattice_parameters()Lattice.get_lattice_constants()Lattice.metric_tensor()Lattice.get_points()Lattice.guess_symmetry()Lattice.guess_symmetry_from_parameters()Lattice.from_cif()Lattice.from_symbol()Lattice.cubic()Lattice.body_centered_cubic()Lattice.face_centered_cubic()Lattice.tetragonal()Lattice.body_centered_tetragonal()Lattice.orthorhombic()Lattice.base_centered_orthorhombic()Lattice.body_centered_orthorhombic()Lattice.face_centered_orthorhombic()Lattice.hexagonal()Lattice.rhombohedral()Lattice.monoclinic()Lattice.base_centered_monoclinic()Lattice.triclinic()Lattice.from_symmetry()Lattice.from_parameters()Lattice.volume()Lattice.ubi_to_rod()Lattice.get_hkl_family()Lattice.get_slip_systems()
SlipSystemHklObjectHklDirectionHklPlaneHklPlane.normal()HklPlane.scattering_vector()HklPlane.friedel_pair()HklPlane.interplanar_spacing()HklPlane.bragg_angle()HklPlane.four_to_three_indices()HklPlane.three_to_four_indices()HklPlane.is_in_list()HklPlane.is_same_family()HklPlane.from_families()HklPlane.get_family()HklPlane.get_hkl_family()HklPlane.multiplicity()HklPlane.slip_trace()HklPlane.plot_slip_traces()HklPlane.plot_XY_slip_traces()HklPlane.plot_YZ_slip_traces()HklPlane.plot_XZ_slip_traces()HklPlane.indices_from_two_directions()
microstructureModuleOrientationOrientation.__init__()Orientation.orientation_matrix()Orientation.to_crystal()Orientation.to_sample()Orientation.cube()Orientation.brass()Orientation.copper()Orientation.s3()Orientation.goss()Orientation.shear()Orientation.random()Orientation.ipf_color()Orientation.compute_mean_orientation()Orientation.compute_mean_rodrigues()Orientation.fzDihedral()Orientation.inFZ()Orientation.move_to_FZ()Orientation.rotate_orientation()Orientation.misorientation_MacKenzie()Orientation.misorientation_axis_from_delta()Orientation.misorientation_axis()Orientation.misorientation_angle_from_delta()Orientation.disorientation()Orientation.phi1()Orientation.Phi()Orientation.phi2()Orientation.plot()Orientation.compute_XG_angle()Orientation.solve_trig_equation()Orientation.dct_omega_angles()Orientation.rotating_crystal()Orientation.compute_instrument_transformation_matrix()Orientation.topotomo_tilts()Orientation.from_euler()Orientation.from_rodrigues()Orientation.from_Quaternion()Orientation.from_n1n2()Orientation.from_amitex()Orientation.transformation_matrix()Orientation.from_two_hkl_normals()Orientation.Zrot2OrientationMatrix()Orientation.OrientationMatrix2EulerSF()Orientation.OrientationMatrix2Euler()Orientation.OrientationMatrix2Rodrigues()Orientation.OrientationMatrix2Quaternion()Orientation.Rodrigues2OrientationMatrix()Orientation.Rodrigues2Axis()Orientation.Axis2OrientationMatrix()Orientation.Axis2Quaternion()Orientation.Euler2Axis()Orientation.Euler2Quaternion()Orientation.Euler2Rodrigues()Orientation.eu2ro()Orientation.Euler2OrientationMatrix()Orientation.Quaternion2Euler()Orientation.Quaternion2OrientationMatrix()Orientation.read_euler_txt()Orientation.read_orientations()Orientation.read_euler_from_zset_inp()Orientation.slip_system_orientation_tensor()Orientation.slip_system_orientation_strain_tensor()Orientation.slip_system_orientation_rotation_tensor()Orientation.schmid_factor()Orientation.compute_all_schmid_factors()Orientation.compute_m_factor()
GrainMicrostructureMicrostructure.__init__()Microstructure.minimal_data_model()Microstructure.sync_phases()Microstructure.set_phase()Microstructure.set_phases()Microstructure.set_phase_elastic_constants()Microstructure.get_number_of_phases()Microstructure.get_number_of_grains()Microstructure.add_phase()Microstructure.get_phase_list()Microstructure.get_phase_ids_list()Microstructure.get_phase()Microstructure.get_lattice()Microstructure.get_grain_map()Microstructure.get_phase_map()Microstructure.get_orientation_map()Microstructure.get_mask()Microstructure.get_ids_from_grain_map()Microstructure.get_grain_ids()Microstructure.id_list_to_condition()Microstructure.get_grain_volumes()Microstructure.get_grain_centers()Microstructure.get_grain_rodrigues()Microstructure.get_grain_orientations()Microstructure.get_grain_bounding_boxes()Microstructure.get_voxel_size()Microstructure.get_grain()Microstructure.get_all_grains()Microstructure.get_grain_positions()Microstructure.get_grain_volume_fractions()Microstructure.get_grain_volume_fraction()Microstructure.set_orientations()Microstructure.set_centers()Microstructure.set_bounding_boxes()Microstructure.set_volumes()Microstructure.set_grain_phases()Microstructure.set_lattice()Microstructure.set_active_grain_map()Microstructure.set_active_phase_map()Microstructure.set_grain_map()Microstructure.set_phase_map()Microstructure.update_phase_map_from_grains()Microstructure.set_orientation_map()Microstructure.set_mask()Microstructure.set_random_orientations()Microstructure.remove_grains_not_in_map()Microstructure.remove_small_grains()Microstructure.remove_grains_from_table()Microstructure.add_grains()Microstructure.add_grains_in_map()Microstructure.random_texture()Microstructure.set_mesh()Microstructure.create_grain_ids_field()Microstructure.create_orientation_field()Microstructure.create_orientation_map()Microstructure.add_grain_lattices_representation()Microstructure.fz_grain_orientation_data()Microstructure.compute_god_map()Microstructure.add_IPF_maps()Microstructure.create_IPF_map()Microstructure.view_slice()Microstructure.rand_cmap()Microstructure.ipf_cmap()Microstructure.from_grain_file()Microstructure.print_grains_info()Microstructure.match_grains()Microstructure.match_orientation()Microstructure.find_neighbors()Microstructure.dilate_grain()Microstructure.dilate_labels()Microstructure.dilate_grains()Microstructure.clean_grain_map()Microstructure.mesh_grain_map()Microstructure.crop()Microstructure.sync_grain_table_with_grain_map()Microstructure.renumber_grains()Microstructure.compute_grain_volume()Microstructure.compute_grain_center()Microstructure.compute_grain_bounding_box()Microstructure.compute_grain_equivalent_diameters()Microstructure.compute_grain_sphericities()Microstructure.compute_grain_aspect_ratios()Microstructure.recompute_grain_volumes()Microstructure.recompute_grain_centers()Microstructure.recompute_grain_bounding_boxes()Microstructure.compute_grains_geometry()Microstructure.compute_grains_map_table_intersection()Microstructure.build_grain_table_from_grain_map()Microstructure.graph()Microstructure.segment_mtr()Microstructure.voronoi()Microstructure.to_amitex_fftp()Microstructure.from_amitex_fftp()Microstructure.print_zset_material_block()Microstructure.to_dream3d()Microstructure.from_dream3d()Microstructure.copy_sample()Microstructure.from_neper()Microstructure.from_labdct()Microstructure.from_dct()Microstructure.from_legacy_h5()Microstructure.from_ebsd()Microstructure.merge_microstructures()Microstructure.get_grain_boundaries_map()Microstructure.resample()
textureModulePoleFigurePoleFigure.__init__()PoleFigure.get_orientations()PoleFigure.set_hkl_poles()PoleFigure.set_map_field()PoleFigure.plot_pole_figures()PoleFigure.plot_crystal_dir()PoleFigure.plot_line_between_crystal_dir()PoleFigure.plot_pf_background()PoleFigure.plot_pf_dir()PoleFigure.plot_pf()PoleFigure.create_pf_contour()PoleFigure.plot_pf_contour()PoleFigure.sst_symmetry()PoleFigure.sst_symmetry_cubic()PoleFigure.get_color_from_field()PoleFigure.plot_sst()PoleFigure.plot_ipf()PoleFigure.plot_grain_orientation_change_ipf()PoleFigure.plot()PoleFigure.plot_euler()
TaylorModel
- Subpackages
- file Package
- view Package
vol_utilsModulevtk_animModulevtk_utilsModuleto_vtk_type()rand_cmap()pv_rand_cmap()pyplot_cmap()gray_cmap()invert_cmap()hsv_cmap()jet_cmap()hot_cmap()add_hklplane_to_grain()add_slip_system_to_grain()add_plane_to_grid()axes_actor()grain_3d()add_grain_to_3d_scene()add_local_orientation_axes()add_HklPlanes_with_orientation_in_grain()unit_arrow_3d()lattice_points()lattice_grid()hexagonal_lattice_grid()lattice_edges()lattice_vertices()crystal_vertices()crystal_3d()lattice_3d()lattice_3d_with_planes()lattice_3d_with_plane_series()pole_figure_3d()apply_translation_to_actor()apply_rotation_to_actor()apply_orientation_to_actor()load_STL_actor()is_in_array()read_image_data()data_outline()box_3d()detector_3d()build_line_mesh()line_actor()line_3d()circle_line_3d()point_cloud_3d()contourFilter()volren()elevationFilter()numpy_array_to_vtk_grid()map_data_with_clip()map_data()set_opacity()color_bar()text()setup_camera()render()extract_poly_data()select()show_array()show_mesh()show_grains()show_boundaries()edges_actor()xray_arrow()slits()pin_hole()zone_plate()grid_vol_view()vol_view()ask_for_map_file()
- xray Package
dctModuleXrd3dForwardSimulationDctForwardSimulationDctForwardSimulation.__init__()DctForwardSimulation.set_hkl_planes()DctForwardSimulation.set_diffracting_famillies()DctForwardSimulation.setup()DctForwardSimulation.load_grain()DctForwardSimulation.grain_projection_image()DctForwardSimulation.grain_projection_exp()DctForwardSimulation.grain_projections()DctForwardSimulation.grain_projection_simulation()DctForwardSimulation.dct_projection()
add_to_image()merge_dct_scans()all_dif_spots()plot_all_dif_spots()output_tikzpicture()tt_rock()tt_stack_h5()tt_stack()tt_sim_rc()
detectorsModuleDetector2dRegArrayDetector2dRegArrayDetector2d.__init__()RegArrayDetector2d.compute_tilt_matrix()RegArrayDetector2d.apply_tilts()RegArrayDetector2d.clear_data()RegArrayDetector2d.set_binning()RegArrayDetector2d.set_u_dir()RegArrayDetector2d.set_v_dir()RegArrayDetector2d.get_pixel_size()RegArrayDetector2d.get_size_px()RegArrayDetector2d.get_size_mm()RegArrayDetector2d.get_origin()RegArrayDetector2d.get_edges()RegArrayDetector2d.project_along_direction()RegArrayDetector2d.project_along_directions()RegArrayDetector2d.lab_to_pixel()RegArrayDetector2d.pixel_to_lab()RegArrayDetector2d.load_image()RegArrayDetector2d.compute_corrected_image()RegArrayDetector2d.compute_geometry()RegArrayDetector2d.compute_TwoTh_Psi_arrays()RegArrayDetector2d.angles_to_pixels()RegArrayDetector2d.from_poni()
Varian2520Mar165PerkinElmer1620Xpad
experimentModuleForwardSimulationXraySourceSlitsGeometryObjectGeometrySampleExperimentExperiment.__init__()Experiment.set_sample()Experiment.get_sample()Experiment.set_source()Experiment.get_source()Experiment.set_slits()Experiment.get_slits()Experiment.add_detector()Experiment.get_number_of_detectors()Experiment.get_active_detector()Experiment.forward_simulation()Experiment.save()Experiment.load()
ExperimentEncoder
fittingModulelaueModuleselect_lambda()build_list()compute_ellipsis()diffracted_vector()diffracted_intensity()Alexiane_compute_Laue_pattern()compute_Laue_pattern()gnomonic_projection_point()gnomonic_projection()identify_hkl_from_list()triplet_indexing()confidence_index()poll_system()index()zone_axis_list()get_gnomonic_edges()diffracting_normals_vector()LaueForwardSimulationLaueForwardSimulation.__init__()LaueForwardSimulation.set_experiment()LaueForwardSimulation.set_use_energy_limits()LaueForwardSimulation.set_hkl_planes()LaueForwardSimulation.setup()LaueForwardSimulation.fsim_laue()LaueForwardSimulation.fsim_grain_legacy()LaueForwardSimulation.select_hkl_planes()LaueForwardSimulation.fsim_grain()LaueForwardSimulation.fsim()
xray_utilsModule