DefDAP
develop
Installation
How to use
Load in packages
Load in a HRDIC map
Set the scale of the map
Plot the map with a scale bar
Crop the map
Statistics
Set the location of the DIC pattern images
Load in an EBSD map
Plot the EBSD map
Detect grains in the EBSD
Single grain analysis
Multi grain analysis
Linking the HRDIC and EBSD
Define homologous points
Link the maps
Show the transformation
Segment into grains
Plotting examples
Built-in plots
IPF plotting
Create your own
Functions for grain averaging and grain segmentation
Composite plots
Contributing
Coding style
Repository Structure
Instructions
Additional notes
Documentation
Papers
2024
2023
2022
2021
2020
2019
2018
License
API Documentation
defdap.base module
defdap.crystal module
defdap.ebsd module
defdap.experiment module
defdap.file_readers module
defdap.file_writers module
defdap.hrdic module
defdap.inspector module
defdap.plotting module
defdap.quat module
defdap.utils module
Index
DefDAP
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
_
_generators (defdap.utils.Datastore attribute)
_grains (defdap.base.Map attribute)
_store (defdap.utils.Datastore attribute)
A
add() (defdap.utils.Datastore method)
add_arrow() (defdap.plotting.Plot method)
add_axes() (defdap.plotting.Plot method)
add_axis() (defdap.plotting.PolePlot method)
add_button() (defdap.plotting.Plot method)
add_colour_bar() (defdap.plotting.GrainPlot method)
(defdap.plotting.MapPlot method)
(defdap.plotting.PolePlot method)
add_derivative() (defdap.utils.Datastore method)
add_event_handler() (defdap.plotting.Plot method)
add_generator() (defdap.utils.Datastore method)
add_grain_boundaries() (defdap.plotting.MapPlot method)
add_grain_highlights() (defdap.plotting.MapPlot method)
add_grain_numbers() (defdap.plotting.MapPlot method)
add_hist() (defdap.plotting.HistPlot method)
add_increment() (defdap.experiment.Experiment method)
add_legend() (defdap.plotting.HistPlot method)
(defdap.plotting.MapPlot method)
(defdap.plotting.PolePlot method)
add_line() (defdap.plotting.PolePlot method)
add_map() (defdap.experiment.Increment method)
(defdap.plotting.MapPlot method)
add_points() (defdap.plotting.MapPlot method)
(defdap.plotting.PolePlot method)
add_scale_bar() (defdap.plotting.GrainPlot method)
(defdap.plotting.MapPlot method)
add_slip_bands() (defdap.plotting.GrainPlot method)
add_slip_traces() (defdap.plotting.GrainPlot method)
add_text() (defdap.plotting.Plot method)
add_text_box() (defdap.plotting.Plot method)
add_traces() (defdap.plotting.GrainPlot method)
add_verts() (defdap.plotting.CrystalPlot method)
addBoundaryPoint() (defdap.ebsd.BoundarySegment method)
addMap() (defdap.plotting.GrainPlot method)
apply_threshold_mask() (defdap.hrdic.Map method)
B
batch_run_sta() (defdap.inspector.GrainInspector method)
binning (defdap.hrdic.Map attribute)
boundary_lines (defdap.ebsd.BoundarySegment property)
boundary_point_pairs() (defdap.ebsd.BoundarySegment method)
boundary_point_pairs_x (defdap.ebsd.BoundarySegment property)
boundary_point_pairs_y (defdap.ebsd.BoundarySegment property)
boundary_points_to_lines() (defdap.ebsd.BoundarySet static method)
BoundarySegment (class in defdap.ebsd)
BoundarySet (class in defdap.ebsd)
(class in defdap.hrdic)
bseScale (defdap.hrdic.Map attribute)
build_mis_ori_list() (defdap.ebsd.Grain method)
build_neighbour_network() (defdap.base.Map method)
(defdap.ebsd.Map method)
C
c_over_a (defdap.crystal.Phase property)
(defdap.ebsd.Map property)
calc_average_grain_schmid_factors() (defdap.ebsd.Map method)
calc_average_ori() (defdap.ebsd.Grain method)
(defdap.quat.Quat static method)
calc_average_schmid_factors() (defdap.ebsd.Grain method)
calc_euler_colour() (defdap.ebsd.Map method)
calc_fund_dirs() (defdap.quat.Quat static method)
calc_grain_av_oris() (defdap.ebsd.Map method)
calc_grain_average() (defdap.base.Map method)
calc_grain_mis_ori() (defdap.ebsd.Map method)
calc_grod() (defdap.ebsd.Grain method)
calc_ipf_colour() (defdap.ebsd.Map method)
calc_ipf_colours() (defdap.quat.Quat static method)
calc_kam() (defdap.ebsd.Map method)
calc_line_profile() (defdap.base.Map method)
calc_nye() (defdap.ebsd.Map method)
calc_proxigram() (defdap.base.Map method)
calc_quat_array() (defdap.ebsd.Map method)
calc_rdr() (defdap.ebsd.Grain method)
(defdap.ebsd.Map method)
(defdap.inspector.GrainInspector method)
calc_slip_bands() (defdap.hrdic.Grain method)
calc_slip_traces() (defdap.ebsd.Grain method)
(defdap.hrdic.Grain method)
calc_sym_eqvs() (defdap.quat.Quat static method)
calcMisOri() (defdap.quat.Quat static method)
centre_coords() (defdap.base.Grain method)
check_data() (defdap.file_readers.DICDataLoader method)
(defdap.file_readers.EBSDDataLoader method)
check_ebsd_linked() (defdap.hrdic.Map method)
check_interactive() (defdap.plotting.Plot method)
check_metadata() (defdap.file_readers.EBSDDataLoader method)
checkMetadata() (defdap.file_readers.DICDataLoader method)
clear() (defdap.plotting.Plot method)
clear_all_lines() (defdap.inspector.GrainInspector method)
click_grain_guess() (defdap.ebsd.Linker method)
click_grain_id() (defdap.base.Map method)
click_grain_neighbours() (defdap.base.Map method)
click_set_origin() (defdap.ebsd.Linker method)
conjugate (defdap.quat.Quat property)
convert_idc() (in module defdap.crystal)
corrVal (defdap.hrdic.Map attribute)
create() (defdap.plotting.GrainPlot class method)
(defdap.plotting.HistPlot class method)
(defdap.plotting.MapPlot class method)
create_many_quats() (defdap.quat.Quat static method)
crop() (defdap.base.Map method)
(defdap.hrdic.Map method)
crop_dists (defdap.hrdic.Map attribute)
crystal_sym (defdap.ebsd.Grain property)
(defdap.ebsd.Map property)
(defdap.hrdic.Map property)
CrystalPlot (class in defdap.plotting)
CrystalStructure (class in defdap.crystal)
D
data (defdap.ebsd.Grain attribute)
(defdap.ebsd.Map attribute)
(defdap.hrdic.Grain attribute)
(defdap.hrdic.Map attribute)
DataGenerationError
Datastore (class in defdap.utils)
DavisLoader (class in defdap.file_readers)
defdap.base
module
defdap.crystal
module
defdap.ebsd
module
defdap.experiment
module
defdap.file_readers
module
defdap.file_writers
module
defdap.hrdic
module
defdap.inspector
module
defdap.plotting
module
defdap.quat
module
defdap.utils
module
DICDataLoader (class in defdap.file_readers)
dicMap (defdap.hrdic.Grain attribute)
display_neighbours() (defdap.base.Map method)
dot() (defdap.quat.Quat method)
draw() (defdap.plotting.Plot method)
draw_line_profile() (defdap.base.Map method)
E
ebsd_grain (defdap.hrdic.Grain attribute)
ebsd_map (defdap.ebsd.Grain attribute)
(defdap.hrdic.Grain attribute)
(defdap.hrdic.Map attribute)
ebsd_maps (defdap.ebsd.Linker attribute)
EBSDDataLoader (class in defdap.file_readers)
EBSDDataWriter (class in defdap.file_writers)
EdaxAngLoader (class in defdap.file_readers)
euler_angles() (defdap.quat.Quat method)
exists (defdap.plotting.Plot property)
Experiment (class in defdap.experiment)
extract_quat_comps() (defdap.quat.Quat static method)
extreme_coords (defdap.base.Grain property)
F
filter_data() (defdap.ebsd.Map method)
find_boundaries() (defdap.ebsd.Map method)
find_grains() (defdap.ebsd.Map method)
(defdap.hrdic.Map method)
fname (defdap.hrdic.Map attribute)
format (defdap.hrdic.Map attribute)
Frame (class in defdap.experiment)
from_axis_angle() (defdap.quat.Quat class method)
from_boundary_segments() (defdap.ebsd.BoundarySet class method)
from_ebsd_boundaries() (defdap.hrdic.BoundarySet class method)
from_euler_angles() (defdap.quat.Quat class method)
from_image() (defdap.ebsd.BoundarySet class method)
G
generate() (defdap.utils.Datastore method)
generate_family() (defdap.crystal.SlipSystem method)
generate_id() (defdap.utils.Datastore static method)
generate_threshold_mask() (defdap.hrdic.Map method)
get_frame_transform() (defdap.experiment.Experiment method)
get_loader() (defdap.file_readers.DICDataLoader static method)
(defdap.file_readers.EBSDDataLoader static method)
get_metadata() (defdap.utils.Datastore method)
get_writer() (defdap.file_writers.EBSDDataWriter static method)
goto_grain() (defdap.inspector.GrainInspector method)
Grain (class in defdap.base)
(class in defdap.ebsd)
(class in defdap.hrdic)
grain_data() (defdap.base.Grain method)
grain_data_to_map() (defdap.base.Map method)
grain_data_to_map_data() (defdap.base.Map method)
grain_id (defdap.base.Grain attribute)
grain_inspector() (defdap.hrdic.Map method)
grain_map_data() (defdap.base.Grain method)
grain_map_data_coarse() (defdap.base.Grain method)
grain_outline() (defdap.base.Grain method)
GrainInspector (class in defdap.inspector)
GrainPlot (class in defdap.plotting)
grains (defdap.base.Map property)
group() (defdap.crystal.SlipSystem static method)
group_lines() (defdap.inspector.GrainInspector method)
groups_list (defdap.hrdic.Grain attribute)
H
highlight_alpha (defdap.hrdic.Map attribute)
HistPlot (class in defdap.plotting)
homog_click() (defdap.experiment.Frame static method)
homog_click_save() (defdap.experiment.Frame method)
homog_key() (defdap.experiment.Frame static method)
I
image (defdap.ebsd.BoundarySet property)
(defdap.hrdic.BoundarySet property)
image_x (defdap.ebsd.BoundarySet property)
image_y (defdap.ebsd.BoundarySet property)
Increment (class in defdap.experiment)
iter_over_maps() (defdap.experiment.Experiment method)
K
keys() (defdap.utils.Datastore method)
L
l_matrix() (defdap.crystal.CrystalStructure static method)
label_point() (defdap.plotting.PolePlot method)
lambert_project() (defdap.plotting.PolePlot static method)
line_slice() (defdap.plotting.Plot method)
lines (defdap.ebsd.BoundarySet property)
link_ebsd_map() (defdap.hrdic.Map method)
link_frames() (defdap.experiment.Experiment method)
Linker (class in defdap.ebsd)
links (defdap.ebsd.Linker attribute)
load() (defdap.crystal.SlipSystem static method)
(defdap.file_readers.DavisLoader method)
(defdap.file_readers.DICDataLoader method)
(defdap.file_readers.EBSDDataLoader method)
(defdap.file_readers.EdaxAngLoader method)
(defdap.file_readers.OpenPivLoader method)
(defdap.file_readers.OxfordBinaryLoader method)
(defdap.file_readers.OxfordTextLoader method)
(defdap.file_readers.PythonDictLoader method)
load_corr_val_data() (defdap.hrdic.Map method)
load_data() (defdap.base.Map method)
(defdap.ebsd.Map method)
(defdap.hrdic.Map method)
load_davis_image_data() (defdap.file_readers.DavisLoader static method)
load_file() (defdap.inspector.GrainInspector method)
load_oxford_cpr() (defdap.file_readers.OxfordBinaryLoader method)
load_oxford_crc() (defdap.file_readers.OxfordBinaryLoader method)
load_pattern() (defdap.hrdic.Map method)
locate_grain() (defdap.base.Map method)
lookup_derivative_keys() (defdap.utils.Datastore method)
M
make_link() (defdap.ebsd.Linker method)
Map (class in defdap.base)
(class in defdap.ebsd)
(class in defdap.hrdic)
MAPNAME (defdap.ebsd.Map attribute)
(defdap.hrdic.Map attribute)
MapPlot (class in defdap.plotting)
maxShearList (defdap.hrdic.Grain attribute)
mis_ori (defdap.ebsd.Map attribute)
mis_ori() (defdap.quat.Quat method)
mis_ori_axis (defdap.ebsd.Map attribute)
mis_ori_axis() (defdap.quat.Quat method)
misorientation() (defdap.ebsd.BoundarySegment method)
module
defdap.base
defdap.crystal
defdap.ebsd
defdap.experiment
defdap.file_readers
defdap.file_writers
defdap.hrdic
defdap.inspector
defdap.plotting
defdap.quat
defdap.utils
multiply_many_quats() (defdap.quat.Quat static method)
N
norm() (defdap.quat.Quat method)
normalise() (defdap.quat.Quat method)
num_phases (defdap.ebsd.Map property)
O
OpenPivLoader (class in defdap.file_readers)
origin (defdap.ebsd.Map attribute)
original_shape (defdap.hrdic.Map property)
owner_map (defdap.base.Grain attribute)
(defdap.ebsd.Grain attribute)
ownerMap (defdap.hrdic.Grain attribute)
OxfordBinaryLoader (class in defdap.file_readers)
OxfordTextLoader (class in defdap.file_readers)
OxfordTextWriter (class in defdap.file_writers)
P
parse_phase() (defdap.file_readers.EdaxAngLoader static method)
path (defdap.hrdic.Map attribute)
Phase (class in defdap.crystal)
phase (defdap.ebsd.Grain attribute)
phase_id (defdap.ebsd.Grain attribute)
phases (defdap.ebsd.Map attribute)
Plot (class in defdap.plotting)
plot_average_grain_schmid_factors_map() (defdap.ebsd.Map method)
plot_boundary_map() (defdap.ebsd.Map method)
plot_euler_map() (defdap.ebsd.Map method)
plot_grain_av_max_shear() (defdap.hrdic.Map method)
plot_grain_data() (defdap.base.Grain method)
plot_grain_data_ipf() (defdap.base.Map method)
plot_grain_data_map() (defdap.base.Map method)
plot_grain_map() (defdap.ebsd.Map method)
plot_grain_numbers() (defdap.base.Map method)
plot_ipf() (defdap.quat.Quat method)
plot_ipf_map() (defdap.ebsd.Map method)
plot_map() (defdap.base.Map method)
plot_max_shear() (defdap.hrdic.Grain method)
plot_mis_ori() (defdap.ebsd.Grain method)
plot_mis_ori_map() (defdap.ebsd.Map method)
plot_ori_spread() (defdap.ebsd.Grain method)
plot_outline() (defdap.base.Grain method)
plot_phase_boundary_map() (defdap.ebsd.Map method)
plot_phase_map() (defdap.ebsd.Map method)
plot_rdr() (defdap.inspector.GrainInspector method)
plot_ref_ori() (defdap.ebsd.Grain method)
plot_unit_cell() (defdap.ebsd.Grain method)
(defdap.quat.Quat method)
plots (defdap.ebsd.Linker attribute)
points (defdap.ebsd.BoundarySet property)
points_list (defdap.hrdic.Grain attribute)
polar_angles() (defdap.quat.Quat static method)
PolePlot (class in defdap.plotting)
pos_idc() (in module defdap.crystal)
primary_phase (defdap.ebsd.Map property)
print_slip_system_directory() (defdap.crystal.SlipSystem static method)
print_slip_systems() (defdap.crystal.Phase method)
print_slip_traces() (defdap.ebsd.Grain method)
print_stats_table() (defdap.hrdic.Map method)
proxigram (defdap.base.Map property)
PythonDictLoader (class in defdap.file_readers)
Q
q_matrix() (defdap.crystal.CrystalStructure static method)
Quat (class in defdap.quat)
quat_coef (defdap.quat.Quat attribute)
R
read_until_string() (in module defdap.file_readers)
redraw() (defdap.inspector.GrainInspector method)
redraw_line() (defdap.inspector.GrainInspector method)
reduce_idc() (in module defdap.crystal)
ref_ori (defdap.hrdic.Grain property)
remove_line() (defdap.inspector.GrainInspector method)
report_progress() (in module defdap.utils)
reset_links() (defdap.ebsd.Linker method)
retrieve_name() (defdap.hrdic.Map method)
rot_matrix() (defdap.quat.Quat method)
rotate_data() (defdap.ebsd.Map method)
run_rdr_group() (defdap.inspector.GrainInspector method)
S
safe_int_cast() (in module defdap.crystal)
save() (defdap.ebsd.Map method)
save_file() (defdap.inspector.GrainInspector method)
save_line() (defdap.inspector.GrainInspector method)
scale (defdap.ebsd.Map property)
(defdap.hrdic.Map property)
sel_grain (defdap.base.Map attribute)
set_crop() (defdap.hrdic.Map method)
set_homog_point() (defdap.base.Map method)
(defdap.experiment.Frame method)
set_homog_points() (defdap.experiment.Frame method)
set_origin() (defdap.ebsd.Linker method)
set_pattern() (defdap.hrdic.Map method)
set_ref_ori_from_master() (defdap.ebsd.Linker method)
set_scale() (defdap.hrdic.Map method)
set_size() (defdap.plotting.Plot method)
set_title() (defdap.plotting.Plot method)
shape (defdap.hrdic.Map attribute)
slip_dir_label (defdap.crystal.SlipSystem property)
slip_plane_label (defdap.crystal.SlipSystem property)
slip_traces (defdap.ebsd.Grain property)
(defdap.hrdic.Grain property)
SlipSystem (class in defdap.crystal)
start_linking() (defdap.ebsd.Linker method)
step_size (defdap.ebsd.Map attribute)
stereo_project() (defdap.plotting.PolePlot static method)
str_idx() (in module defdap.crystal)
sym_eqv() (defdap.quat.Quat static method)
T
transform_vector() (defdap.quat.Quat method)
U
update() (defdap.utils.Datastore method)
update_filename() (defdap.inspector.GrainInspector method)
update_homog_points() (defdap.experiment.Frame method)
update_misori() (defdap.ebsd.Linker method)
V
version (defdap.hrdic.Map attribute)
W
warp_image() (defdap.experiment.Experiment method)
warp_lines() (defdap.experiment.Experiment method)
warp_points() (defdap.experiment.Experiment method)
warp_to_dic_frame() (defdap.hrdic.Map method)
write() (defdap.file_writers.OxfordTextWriter method)
X
x_dim (defdap.base.Map property)
xdim (defdap.hrdic.Map attribute)
Y
y_dim (defdap.base.Map property)
ydim (defdap.hrdic.Map attribute)
Read the Docs
v: develop
Versions
latest
develop
Downloads
On Read the Docs
Project Home
Builds