axon_synthesis.synthesis.outputs¶

Define the class to store the synthesis outputs.

Classes

`OutputConfig`(path[, final_figures, ...])	Class to store the parameters for the outputs.
`Outputs`(config, *[, exists, create])	Class to store the synthesis outputs.

class axon_synthesis.synthesis.outputs.OutputConfig(path, final_figures: bool = False, graph_creation_figures: bool = False, graph_creation_data: bool = False, main_trunk_figures: bool = False, main_trunk_morphologies: bool = False, morphologies: bool = True, morphologies_edges: bool = False, postprocess_trunk_figures: bool = False, postprocess_trunk_morphologies: bool = False, steiner_tree_solution_figures: bool = False, steiner_tree_solutions: bool = False, target_point_figures: bool = False, target_points: bool = False, tuft_figures: bool = False, tuft_morphologies: bool = False)¶

Bases: object

Class to store the parameters for the outputs.

path¶

The path to the output directory.

Type:: pathlib.Path

final_figures¶

Enable export of the final figures.

Type:: bool

graph_creation_figures¶

Enable export of the graph creation figures.

Type:: bool

graph_creation_data¶

Enable export of the graph creation data.

Type:: bool

main_trunk_figures¶

Enable export of the main trunk figures.

Type:: bool

main_trunk_morphologies¶

Enable export of the main trunk morphologies.

Type:: bool

morphologies¶

Enable export of the final morphologies.

Type:: bool

morphologies_edges¶

Enable export of the final morphologies as edges.

Type:: bool

postprocess_trunk_figures¶

Enable export of the postprocess trunk figures.

Type:: bool

postprocess_trunk_morphologies¶

Enable export of the postprocess trunk morphologies.

Type:: bool

steiner_tree_solution_figures¶

Enable export of the steiner tree solution figures.

Type:: bool

steiner_tree_solutions¶

Enable export of the steiner tree solutions.

Type:: bool

target_point_figures¶

Enable export of the target point figures.

Type:: bool

target_points¶

Enable export of the target points.

Type:: bool

tuft_figures¶

Enable export of the tuft figures.

Type:: bool

tuft_morphologies¶

Enable export of the tuft morphologies.

Type:: bool

class axon_synthesis.synthesis.outputs.Outputs(config: OutputConfig, *, exists: bool = False, create: bool = False)¶

Bases: BasePathBuilder

Class to store the synthesis outputs.