freud
v2.6.1
Getting Started
Introduction
Installation
Quickstart Guide
Tutorial
Examples
Topic Guides
Query API
Using
freud
Efficiently
Reading Simulation Data for
freud
API
Box Module
Cluster Module
Data Module
Density Module
Diffraction Module
Environment Module
Interface Module
Locality Module
MSD Module
Order Module
Parallel Module
PMFT Module
Reference
Development Guide
How to cite
freud
References
License
Credits
freud
»
Index
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
Symbols
--COVERAGE
A
a1 (freud.data.UnitCell property)
a2 (freud.data.UnitCell property)
a3 (freud.data.UnitCell property)
AABBQuery (class in freud.locality)
angles (freud.environment.AngularSeparationGlobal property)
(freud.environment.AngularSeparationNeighbor property)
AngularSeparationGlobal (class in freud.environment)
AngularSeparationNeighbor (class in freud.environment)
average (freud.order.Steinhardt attribute)
B
basis_positions (freud.data.UnitCell property)
bcc() (freud.data.UnitCell class method)
bin_centers (freud.density.CorrelationFunction attribute)
(freud.density.RDF attribute)
(freud.environment.BondOrder attribute)
(freud.pmft.PMFTR12 attribute)
(freud.pmft.PMFTXY attribute)
(freud.pmft.PMFTXYT attribute)
(freud.pmft.PMFTXYZ attribute)
bin_counts (freud.density.CorrelationFunction property)
(freud.density.RDF property)
(freud.environment.BondOrder property)
(freud.pmft.PMFTR12 property)
(freud.pmft.PMFTXY property)
(freud.pmft.PMFTXYT property)
(freud.pmft.PMFTXYZ property)
bin_edges (freud.density.CorrelationFunction attribute)
(freud.density.RDF attribute)
(freud.environment.BondOrder attribute)
(freud.pmft.PMFTR12 attribute)
(freud.pmft.PMFTXY attribute)
(freud.pmft.PMFTXYT attribute)
(freud.pmft.PMFTXYZ attribute)
bond_order (freud.environment.BondOrder property)
BondOrder (class in freud.environment)
bounds (freud.density.CorrelationFunction attribute)
(freud.density.RDF attribute)
(freud.environment.BondOrder attribute)
(freud.pmft.PMFTR12 attribute)
(freud.pmft.PMFTXY attribute)
(freud.pmft.PMFTXYT attribute)
(freud.pmft.PMFTXYZ attribute)
Box (class in freud.box)
box (freud.data.UnitCell property)
(freud.density.CorrelationFunction property)
(freud.density.GaussianDensity property)
(freud.density.LocalDensity property)
(freud.density.RDF property)
(freud.density.SphereVoxelization property)
(freud.environment.BondOrder property)
(freud.locality.AABBQuery attribute)
(freud.locality.LinkCell attribute)
(freud.locality.NeighborQuery attribute)
(freud.msd.MSD attribute)
(freud.pmft.PMFTR12 property)
(freud.pmft.PMFTXY property)
(freud.pmft.PMFTXYT property)
(freud.pmft.PMFTXYZ property)
buffer_box (freud.locality.PeriodicBuffer property)
buffer_ids (freud.locality.PeriodicBuffer property)
buffer_points (freud.locality.PeriodicBuffer property)
C
cell_width (freud.locality.LinkCell attribute)
center() (freud.box.Box method)
center_of_mass() (freud.box.Box method)
centers (freud.cluster.ClusterProperties property)
Cluster (class in freud.cluster)
cluster_environments (freud.environment.EnvironmentCluster property)
cluster_idx (freud.cluster.Cluster property)
(freud.environment.EnvironmentCluster property)
(freud.order.SolidLiquid property)
cluster_keys (freud.cluster.Cluster property)
cluster_sizes (freud.order.SolidLiquid property)
ClusterProperties (class in freud.cluster)
compute() (freud.cluster.Cluster method)
(freud.cluster.ClusterProperties method)
(freud.density.CorrelationFunction method)
(freud.density.GaussianDensity method)
(freud.density.LocalDensity method)
(freud.density.RDF method)
(freud.density.SphereVoxelization method)
(freud.diffraction.DiffractionPattern method)
(freud.environment.AngularSeparationGlobal method)
(freud.environment.AngularSeparationNeighbor method)
(freud.environment.BondOrder method)
(freud.environment.EnvironmentCluster method)
(freud.environment.EnvironmentMotifMatch method)
(freud.environment.LocalBondProjection method)
(freud.environment.LocalDescriptors method)
(freud.interface.Interface method)
(freud.locality.PeriodicBuffer method)
(freud.locality.Voronoi method)
(freud.msd.MSD method)
(freud.order.Cubatic method)
(freud.order.Hexatic method)
(freud.order.Nematic method)
(freud.order.RotationalAutocorrelation method)
(freud.order.SolidLiquid method)
(freud.order.Steinhardt method)
(freud.order.Translational method)
(freud.pmft.PMFTR12 method)
(freud.pmft.PMFTXY method)
(freud.pmft.PMFTXYT method)
(freud.pmft.PMFTXYZ method)
compute_all_distances() (freud.box.Box method)
compute_distances() (freud.box.Box method)
contains() (freud.box.Box method)
copy() (freud.locality.NeighborList method)
correlation (freud.density.CorrelationFunction property)
CorrelationFunction (class in freud.density)
Cubatic (class in freud.order)
cubatic_tensor (freud.order.Cubatic property)
cube() (freud.box.Box class method)
D
default_query_args (freud.cluster.Cluster attribute)
(freud.density.CorrelationFunction attribute)
(freud.density.LocalDensity attribute)
(freud.density.RDF attribute)
(freud.environment.AngularSeparationNeighbor attribute)
(freud.environment.BondOrder attribute)
(freud.environment.EnvironmentCluster attribute)
(freud.environment.EnvironmentMotifMatch attribute)
(freud.environment.LocalBondProjection attribute)
(freud.environment.LocalDescriptors attribute)
(freud.interface.Interface attribute)
(freud.order.Hexatic attribute)
(freud.order.SolidLiquid attribute)
(freud.order.Steinhardt attribute)
(freud.order.Translational attribute)
(freud.pmft.PMFTR12 attribute)
(freud.pmft.PMFTXY attribute)
(freud.pmft.PMFTXYT attribute)
(freud.pmft.PMFTXYZ attribute)
density (freud.density.GaussianDensity property)
(freud.density.LocalDensity property)
diameter (freud.density.LocalDensity attribute)
diffraction (freud.diffraction.DiffractionPattern property)
DiffractionPattern (class in freud.diffraction)
dimensions (freud.box.Box attribute)
(freud.data.UnitCell property)
director (freud.order.Nematic property)
distances (freud.locality.NeighborList attribute)
E
EnvironmentCluster (class in freud.environment)
EnvironmentMotifMatch (class in freud.environment)
F
fcc() (freud.data.UnitCell class method)
filter() (freud.locality.NeighborList method)
filter_r() (freud.locality.NeighborList method)
find_first_index() (freud.locality.NeighborList method)
freud.box
module
freud.cluster
module
freud.data
module
freud.density
module
freud.diffraction
module
freud.environment
module
freud.interface
module
freud.locality
module
freud.msd
module
freud.order
module
freud.parallel
module
freud.pmft
module
from_arrays() (freud.locality.NeighborList class method)
from_box() (freud.box.Box class method)
from_matrix() (freud.box.Box class method)
from_system() (freud.locality.AABBQuery class method)
(freud.locality.LinkCell class method)
(freud.locality.NeighborQuery class method)
G
GaussianDensity (class in freud.density)
generate_system() (freud.data.UnitCell method)
get_box_vector() (freud.box.Box method)
get_images() (freud.box.Box method)
get_num_threads() (in module freud.parallel)
global_tensor (freud.order.Cubatic property)
grid_size (freud.diffraction.DiffractionPattern attribute)
gyrations (freud.cluster.ClusterProperties property)
H
hex() (freud.data.UnitCell class method)
Hexatic (class in freud.order)
I
Interface (class in freud.interface)
is2D (freud.box.Box attribute)
K
k (freud.order.Hexatic attribute)
(freud.order.Translational attribute)
k_values (freud.diffraction.DiffractionPattern property)
k_vectors (freud.diffraction.DiffractionPattern property)
L
L (freud.box.Box attribute)
l (freud.order.RotationalAutocorrelation attribute)
(freud.order.SolidLiquid attribute)
(freud.order.Steinhardt attribute)
L_inv (freud.box.Box attribute)
l_max (freud.environment.LocalDescriptors attribute)
largest_cluster_size (freud.order.SolidLiquid property)
lattice_vectors (freud.data.UnitCell property)
LinkCell (class in freud.locality)
LocalBondProjection (class in freud.environment)
LocalDensity (class in freud.density)
LocalDescriptors (class in freud.environment)
Lx (freud.box.Box attribute)
Ly (freud.box.Box attribute)
Lz (freud.box.Box attribute)
M
make_absolute() (freud.box.Box method)
make_fractional() (freud.box.Box method)
make_random_system() (in module freud.data)
matches (freud.environment.EnvironmentMotifMatch property)
mode (freud.environment.BondOrder attribute)
(freud.environment.LocalDescriptors attribute)
module
freud.box
freud.cluster
freud.data
freud.density
freud.diffraction
freud.environment
freud.interface
freud.locality
freud.msd
freud.order
freud.parallel
freud.pmft
MSD (class in freud.msd)
msd (freud.msd.MSD property)
N
n_r (freud.density.RDF property)
n_replicates (freud.order.Cubatic attribute)
nbins (freud.density.CorrelationFunction attribute)
(freud.density.RDF attribute)
(freud.environment.BondOrder attribute)
(freud.pmft.PMFTR12 attribute)
(freud.pmft.PMFTXY attribute)
(freud.pmft.PMFTXYT attribute)
(freud.pmft.PMFTXYZ attribute)
negative_m (freud.environment.LocalDescriptors attribute)
neighbor_counts (freud.locality.NeighborList attribute)
NeighborList (class in freud.locality)
NeighborQuery (class in freud.locality)
NeighborQueryResult (class in freud.locality)
Nematic (class in freud.order)
nematic_tensor (freud.order.Nematic property)
nlist (freud.environment.AngularSeparationNeighbor property)
(freud.environment.LocalBondProjection property)
(freud.environment.LocalDescriptors property)
(freud.locality.Voronoi property)
(freud.order.SolidLiquid property)
normalize_q (freud.order.SolidLiquid attribute)
normed_projections (freud.environment.LocalBondProjection property)
num_clusters (freud.cluster.Cluster property)
(freud.environment.EnvironmentCluster property)
num_connections (freud.order.SolidLiquid property)
num_neighbors (freud.density.LocalDensity property)
num_points (freud.locality.NeighborList attribute)
num_query_points (freud.locality.NeighborList attribute)
num_sphs (freud.environment.LocalDescriptors property)
NumThreads (class in freud.parallel)
O
order (freud.order.Cubatic property)
(freud.order.Nematic property)
(freud.order.RotationalAutocorrelation property)
(freud.order.Steinhardt property)
orientation (freud.order.Cubatic property)
output_size (freud.diffraction.DiffractionPattern attribute)
P
particle_harmonics (freud.order.SolidLiquid property)
(freud.order.Steinhardt property)
particle_msd (freud.msd.MSD property)
particle_order (freud.order.Cubatic property)
(freud.order.Hexatic property)
(freud.order.RotationalAutocorrelation property)
(freud.order.Steinhardt property)
(freud.order.Translational property)
particle_tensor (freud.order.Nematic property)
periodic (freud.box.Box attribute)
periodic_x (freud.box.Box attribute)
periodic_y (freud.box.Box attribute)
periodic_z (freud.box.Box attribute)
PeriodicBuffer (class in freud.locality)
plot() (freud.box.Box method)
(freud.cluster.Cluster method)
(freud.density.CorrelationFunction method)
(freud.density.GaussianDensity method)
(freud.density.RDF method)
(freud.density.SphereVoxelization method)
(freud.diffraction.DiffractionPattern method)
(freud.environment.EnvironmentCluster method)
(freud.locality.AABBQuery method)
(freud.locality.LinkCell method)
(freud.locality.NeighborQuery method)
(freud.locality.Voronoi method)
(freud.msd.MSD method)
(freud.order.Hexatic method)
(freud.order.SolidLiquid method)
(freud.order.Steinhardt method)
(freud.pmft.PMFTXY method)
pmft (freud.pmft.PMFTR12 property)
(freud.pmft.PMFTXY property)
(freud.pmft.PMFTXYT property)
(freud.pmft.PMFTXYZ property)
PMFTR12 (class in freud.pmft)
PMFTXY (class in freud.pmft)
PMFTXYT (class in freud.pmft)
PMFTXYZ (class in freud.pmft)
point_count (freud.interface.Interface property)
point_environments (freud.environment.EnvironmentCluster property)
(freud.environment.EnvironmentMotifMatch property)
point_ids (freud.interface.Interface property)
point_indices (freud.locality.NeighborList attribute)
points (freud.locality.AABBQuery attribute)
(freud.locality.LinkCell attribute)
(freud.locality.NeighborQuery attribute)
polytopes (freud.locality.Voronoi property)
projections (freud.environment.LocalBondProjection property)
Q
q_threshold (freud.order.SolidLiquid attribute)
ql (freud.order.Steinhardt property)
ql_ij (freud.order.SolidLiquid property)
query() (freud.locality.AABBQuery method)
(freud.locality.LinkCell method)
(freud.locality.NeighborQuery method)
query_point_count (freud.interface.Interface property)
query_point_ids (freud.interface.Interface property)
query_point_indices (freud.locality.NeighborList attribute)
R
r_max (freud.density.GaussianDensity attribute)
(freud.density.LocalDensity attribute)
(freud.density.SphereVoxelization attribute)
radii_of_gyration (freud.cluster.ClusterProperties property)
RDF (class in freud.density)
rdf (freud.density.RDF property)
RotationalAutocorrelation (class in freud.order)
S
sc() (freud.data.UnitCell class method)
scale (freud.order.Cubatic attribute)
seed (freud.order.Cubatic attribute)
segments (freud.locality.NeighborList attribute)
set_num_threads() (in module freud.parallel)
sigma (freud.density.GaussianDensity attribute)
sizes (freud.cluster.ClusterProperties property)
solid_threshold (freud.order.SolidLiquid attribute)
SolidLiquid (class in freud.order)
sph (freud.environment.LocalDescriptors property)
SphereVoxelization (class in freud.density)
square() (freud.box.Box class method)
(freud.data.UnitCell class method)
Steinhardt (class in freud.order)
T
t_final (freud.order.Cubatic attribute)
t_initial (freud.order.Cubatic attribute)
TBB_INCLUDE_DIR
TBBROOT
to_dict() (freud.box.Box method)
to_image() (freud.diffraction.DiffractionPattern method)
to_matrix() (freud.box.Box method)
toNeighborList() (freud.locality.NeighborQueryResult method)
Translational (class in freud.order)
U
u (freud.order.Nematic attribute)
UnitCell (class in freud.data)
unwrap() (freud.box.Box method)
V
v1 (freud.box.Box attribute)
v2 (freud.box.Box attribute)
v3 (freud.box.Box attribute)
volume (freud.box.Box attribute)
volumes (freud.locality.Voronoi property)
Voronoi (class in freud.locality)
voxels (freud.density.SphereVoxelization property)
W
weighted (freud.order.Hexatic attribute)
(freud.order.Steinhardt attribute)
weights (freud.locality.NeighborList attribute)
width (freud.density.GaussianDensity attribute)
(freud.density.SphereVoxelization attribute)
wl (freud.order.Steinhardt attribute)
wrap() (freud.box.Box method)
X
xy (freud.box.Box attribute)
xz (freud.box.Box attribute)
Y
yz (freud.box.Box attribute)
Read the Docs
v: v2.6.1
Versions
latest
stable
v2.6.1
v2.6.0
v2.5.1
v2.5.0
v2.4.1
v2.4.0
v2.3.0
v2.2.0
v2.1.0
v2.0.1
v2.0.0
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.0
v0.11.4
v0.11.3
v0.11.0
v0.10.0
v0.9.0
v0.8.2
v0.8.1
v0.8.0
v0.7.0
v0.6.4
rtd-ld_impl_linux-64
fix-rtd-libgfortran-version
Downloads
On Read the Docs
Project Home
Builds