neat.CompartmentFitter.set_ctree

CompartmentFitter.set_ctree(loc_arg, fit_name='', extend_w_bifurc=True, pprint=False)[source]

Store an initial neat.CompartmentTree, providing a tree structure scaffold for the fit for a given set of locations. The locations are also stored on self under the name ‘fit locs’

Parameters:
  • loc_arg (list of locations or string (see documentation of) – MorphTree.convert_loc_arg_to_locs() for details) The compartment locations

  • fit_name (str (optional, default: '')) – The name of the fit. If provided, the resulting neat.CompartmentTree and list of fit locations will be stored. They can be accessed under the fitted_models attribute of neat.CompartmentFitter.

  • extend_w_bifurc (bool (optional, default True)) – To extend the compartment locations with all intermediate bifurcations (see documentation of MorphTree.extend_with_bifurcation_locs()).

  • pprint (bool) – whether to print additional info

Returns:

  • neat.CompartmentTree – The compartmenttree that is in the process of being fitted.

  • list of <neat.MorphLoc> – The corresponding list of fit locations.