ect
Contents:
1. Getting Started
1.1. Prerequisites
1.2. Installing
ect
1.3. Uninstalling
ect
2. Modules
2.1. Embedded Complex
2.1.1. Overview
2.1.2. Basic Usage
2.1.3. API Reference
2.2. Validation System
2.2.1. Overview
2.2.2. Architecture
2.2.3. Validation Rules
2.2.4. Usage
2.2.5. Custom Validation Rules
2.2.6. API Reference
2.3. ECT
ECT
SECT
DECT
2.4. ECTResult
ECTResult
2.5. Directions
Sampling
Directions
3. Tutorials
3.1. Tutorial: ECT for Embedded Cell Complexes
3.1.1. Basic Usage: Creating Simple Complexes
3.1.2. Adding Cells of Arbitrary Dimension
3.1.3. ECT Computation with Higher-Dimensional Cells
3.1.4. Validation System
3.2. Tutorial for exact ECT computation
3.3. ECT on Matisse’s “The Parakeet and the Mermaid”
3.3.1. Acknowledgements
4. Contributing
4.1. Getting Started
4.2. Contributing Guidelines
4.2.1. Code style and formatting
4.2.2. Documentation guidelines
4.2.3. Testing guidelines
4.2.4. Issue tracking and pull requests
5. License
6. Citing
ect
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
_
__init__() (ect.dect.DECT method)
(ect.directions.Directions method)
(ect.ect.ECT method)
(ect.embed_complex.EmbeddedComplex method)
(ect.sect.SECT method)
(ect.validation.base.ValidationResult method)
(ect.validation.base.ValidationRule method)
(ect.validation.BoundaryEdgeRule method)
(ect.validation.EmbeddingValidator method)
(ect.validation.rules.BoundaryEdgeRule method)
(ect.validation.rules.CoordinateDimensionRule method)
(ect.validation.ValidationResult method)
(ect.validation.ValidationRule method)
(ect.validation.validator.EmbeddingValidator method)
A
add_cell() (ect.embed_complex.EmbeddedComplex method)
add_cycle() (ect.embed_complex.EmbeddedComplex method)
add_edge() (ect.embed_complex.EmbeddedComplex method)
add_face() (ect.embed_complex.EmbeddedComplex method)
add_faces_from() (ect.embed_complex.EmbeddedComplex method)
add_node() (ect.embed_complex.EmbeddedComplex method)
add_nodes_from() (ect.embed_complex.EmbeddedComplex method)
add_nodes_from_dict() (ect.embed_complex.EmbeddedComplex method)
add_rule() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
applies_to_dimension() (ect.validation.base.ValidationRule method)
(ect.validation.BoundaryEdgeRule method)
(ect.validation.DimensionValidityRule method)
(ect.validation.EdgeInteriorRule method)
(ect.validation.FaceInteriorRule method)
(ect.validation.rules.BoundaryEdgeRule method)
(ect.validation.rules.CoordinateDimensionRule method)
(ect.validation.rules.DimensionValidityRule method)
(ect.validation.rules.EdgeInteriorRule method)
(ect.validation.rules.FaceInteriorRule method)
(ect.validation.rules.SelfIntersectionRule method)
(ect.validation.rules.VertexCountRule method)
(ect.validation.SelfIntersectionRule method)
(ect.validation.ValidationRule method)
(ect.validation.VertexCountRule method)
B
bound_radius (ect.ect.ECT attribute)
BoundaryEdgeRule (class in ect.validation)
(class in ect.validation.rules)
C
calculate() (ect.dect.DECT method)
(ect.ect.ECT method)
(ect.sect.SECT method)
cells (ect.embed_complex.EmbeddedComplex attribute)
center_coordinates() (ect.embed_complex.EmbeddedComplex method)
coord_matrix (ect.embed_complex.EmbeddedComplex attribute)
(ect.embed_complex.EmbeddedComplex property)
CoordinateDimensionRule (class in ect.validation.rules)
CUSTOM (ect.directions.Sampling attribute)
D
DECT (class in ect.dect)
dim (ect.embed_complex.EmbeddedComplex attribute)
(ect.embed_complex.EmbeddedComplex property)
DimensionValidityRule (class in ect.validation)
(class in ect.validation.rules)
Directions (class in ect.directions)
directions (ect.ect.ECT attribute)
disable_embedding_validation() (ect.embed_complex.EmbeddedComplex method)
disable_rule() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
dist() (ect.results.ECTResult method)
E
ECT (class in ect.ect)
ect.dect
module
ect.directions
module
ect.ect
module
ect.embed_complex
module
ect.results
module
ect.sect
module
ect.validation
module
ect.validation.base
module
ect.validation.rules
module
ect.validation.validator
module
ECTResult (class in ect.results)
edge_indices (ect.embed_complex.EmbeddedComplex property)
EdgeInteriorRule (class in ect.validation)
(class in ect.validation.rules)
EmbeddedComplex (class in ect.embed_complex)
EmbeddedCW (in module ect.embed_complex)
EmbeddedGraph (in module ect.embed_complex)
embedding_tol (ect.embed_complex.EmbeddedComplex attribute)
EmbeddingValidator (class in ect.validation)
(class in ect.validation.validator)
enable_embedding_validation() (ect.embed_complex.EmbeddedComplex method)
enable_permissive_validation() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
enable_strict_validation() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
Example (ect.ect.ECT attribute)
F
FaceInteriorRule (class in ect.validation)
(class in ect.validation.rules)
faces (ect.embed_complex.EmbeddedComplex property)
from_angles() (ect.directions.Directions class method)
from_csr() (ect.results.ECTResult class method)
from_vectors() (ect.directions.Directions class method)
G
get_bounding_box() (ect.embed_complex.EmbeddedComplex method)
get_bounding_radius() (ect.embed_complex.EmbeddedComplex method)
get_center() (ect.embed_complex.EmbeddedComplex method)
get_coord() (ect.embed_complex.EmbeddedComplex method)
get_normal_angle_matrix() (ect.embed_complex.EmbeddedComplex method)
get_normal_angles() (ect.embed_complex.EmbeddedComplex method)
get_rule_names() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
get_rules_for_dimension() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
get_validator() (ect.embed_complex.EmbeddedComplex method)
H
has_csr (ect.results.ECTResult property)
I
invalid() (ect.validation.base.ValidationResult class method)
(ect.validation.ValidationResult class method)
is_structural (ect.validation.base.ValidationRule property)
(ect.validation.DimensionValidityRule property)
(ect.validation.rules.CoordinateDimensionRule property)
(ect.validation.rules.DimensionValidityRule property)
(ect.validation.rules.VertexCountRule property)
(ect.validation.ValidationRule property)
(ect.validation.VertexCountRule property)
is_valid (ect.validation.base.ValidationResult attribute)
(ect.validation.ValidationResult attribute)
L
load_npz() (ect.results.ECTResult class method)
M
message (ect.validation.base.ValidationResult attribute)
(ect.validation.ValidationResult attribute)
module
ect.dect
ect.directions
ect.ect
ect.embed_complex
ect.results
ect.sect
ect.validation
ect.validation.base
ect.validation.rules
ect.validation.validator
N
name (ect.validation.base.ValidationRule property)
(ect.validation.BoundaryEdgeRule property)
(ect.validation.DimensionValidityRule property)
(ect.validation.EdgeInteriorRule property)
(ect.validation.FaceInteriorRule property)
(ect.validation.rules.BoundaryEdgeRule property)
(ect.validation.rules.CoordinateDimensionRule property)
(ect.validation.rules.DimensionValidityRule property)
(ect.validation.rules.EdgeInteriorRule property)
(ect.validation.rules.FaceInteriorRule property)
(ect.validation.rules.SelfIntersectionRule property)
(ect.validation.rules.VertexCountRule property)
(ect.validation.SelfIntersectionRule property)
(ect.validation.ValidationRule property)
(ect.validation.VertexCountRule property)
node_list (ect.embed_complex.EmbeddedComplex attribute)
(ect.embed_complex.EmbeddedComplex property)
node_to_index (ect.embed_complex.EmbeddedComplex attribute)
(ect.embed_complex.EmbeddedComplex property)
num_dirs (ect.ect.ECT attribute)
num_thresh (ect.ect.ECT attribute)
P
pca_projection() (ect.embed_complex.EmbeddedComplex method)
plot() (ect.embed_complex.EmbeddedComplex method)
(ect.results.ECTResult method)
plot_faces() (ect.embed_complex.EmbeddedComplex method)
position_dict (ect.embed_complex.EmbeddedComplex property)
project_coordinates() (ect.embed_complex.EmbeddedComplex method)
R
RANDOM (ect.directions.Sampling attribute)
random() (ect.directions.Directions class method)
remove_rule() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
S
Sampling (class in ect.directions)
save_npz() (ect.results.ECTResult method)
scale_coordinates() (ect.embed_complex.EmbeddedComplex method)
SECT (class in ect.sect)
SelfIntersectionRule (class in ect.validation)
(class in ect.validation.rules)
set_coord() (ect.embed_complex.EmbeddedComplex method)
set_edge_checker() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
set_tolerance() (ect.validation.base.ValidationRule method)
(ect.validation.EmbeddingValidator method)
(ect.validation.ValidationRule method)
(ect.validation.validator.EmbeddingValidator method)
set_validation_rules() (ect.embed_complex.EmbeddedComplex method)
smooth() (ect.results.ECTResult method)
T
thetas (ect.directions.Directions property)
to_dense() (ect.results.ECTResult method)
transform_coordinates() (ect.embed_complex.EmbeddedComplex method)
U
UNIFORM (ect.directions.Sampling attribute)
uniform() (ect.directions.Directions class method)
V
valid() (ect.validation.base.ValidationResult class method)
(ect.validation.ValidationResult class method)
validate() (ect.validation.base.ValidationRule method)
(ect.validation.BoundaryEdgeRule method)
(ect.validation.DimensionValidityRule method)
(ect.validation.EdgeInteriorRule method)
(ect.validation.FaceInteriorRule method)
(ect.validation.rules.BoundaryEdgeRule method)
(ect.validation.rules.CoordinateDimensionRule method)
(ect.validation.rules.DimensionValidityRule method)
(ect.validation.rules.EdgeInteriorRule method)
(ect.validation.rules.FaceInteriorRule method)
(ect.validation.rules.SelfIntersectionRule method)
(ect.validation.rules.VertexCountRule method)
(ect.validation.SelfIntersectionRule method)
(ect.validation.ValidationRule method)
(ect.validation.VertexCountRule method)
validate_cell() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
validate_cell_safe() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
validate_coordinate_array() (in module ect.validation)
(in module ect.validation.rules)
validate_coordinates() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
validate_embedding (ect.embed_complex.EmbeddedComplex attribute)
validate_node_existence() (in module ect.validation)
(in module ect.validation.rules)
validate_nodes() (ect.validation.EmbeddingValidator method)
(ect.validation.validator.EmbeddingValidator method)
validate_plot_parameters() (ect.embed_complex.EmbeddedComplex method)
ValidationResult (class in ect.validation)
(class in ect.validation.base)
ValidationRule (class in ect.validation)
(class in ect.validation.base)
vectors (ect.directions.Directions property)
VertexCountRule (class in ect.validation)
(class in ect.validation.rules)
violating_indices (ect.validation.base.ValidationResult attribute)
(ect.validation.ValidationResult attribute)