westpa 2022.13__cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

westpa/cli/tools/w_direct.py

@@ -0,0 +1,557 @@
+import logging
+
+import numpy as np
+
+from westpa.core.data_manager import weight_dtype
+from westpa.tools import WESTMasterCommand, WESTParallelTool
+
+from westpa.core import h5io
+from westpa.core.kinetics import sequence_macro_flux_to_rate, WKinetics
+
+from westpa.tools.kinetics_tool import WESTKineticsBase, AverageCommands
+
+from westpa.mclib import mcbs_ci_correl, _1D_simple_eval_block, _2D_simple_eval_block
+
+
+# From w_stateprobs
+from westpa.core.binning import accumulate_state_populations_from_labeled
+
+log = logging.getLogger('w_direct')
+
+
+# This block is responsible for submitting a set of calculations to be bootstrapped over for a particular type of calculation.
+# A property which wishes to be calculated should adhere to this format.
+def _rate_eval_block(iblock, start, stop, nstates, data_input, name, mcbs_alpha, mcbs_nsets, mcbs_acalpha, do_correl, mcbs_enable):
+    # Our rate estimator is a little more complex, so we've defined a custom evaluation block for it,
+    # instead of just using the block evalutors that we've imported.
+    results = []
+    for istate in range(nstates):
+        for jstate in range(nstates):
+            if istate == jstate:
+                continue
+            kwargs = {'istate': istate, 'jstate': jstate}
+            # Why are we sending in the total population dataset, instead of a sliced one?
+            # It's a requirement of our estimator; we need to pull from any given i to j state in order to properly normalize
+            # and avoid i to j rate constants which are affected by a third state k.
+            # That is, we need the populations for both i and j, and it's easier to just send in the entire dataset.
+            dataset = {'dataset': data_input['dataset'][:, istate, jstate], 'pops': data_input['pops']}
+            ci_res = mcbs_ci_correl(
+                dataset,
+                estimator=sequence_macro_flux_to_rate,
+                alpha=mcbs_alpha,
+                n_sets=mcbs_nsets,
+                autocorrel_alpha=mcbs_acalpha,
+                subsample=np.mean,
+                do_correl=do_correl,
+                mcbs_enable=mcbs_enable,
+                estimator_kwargs=kwargs,
+            )
+            results.append((name, iblock, istate, jstate, (start, stop) + ci_res))
+
+    return results
+
+
+# The old w_kinetics
+class DKinetics(WESTKineticsBase, WKinetics):
+    subcommand = 'init'
+    default_kinetics_file = 'direct.h5'
+    default_output_file = 'direct.h5'
+    help_text = 'calculate state-to-state kinetics by tracing trajectories'
+    description = '''\
+Calculate state-to-state rates and transition event durations by tracing
+trajectories.
+
+A bin assignment file (usually "assign.h5") including trajectory labeling
+is required (see "w_assign --help" for information on generating this file).
+
+This subcommand for w_direct is used as input for all other w_direct
+subcommands, which will convert the flux data in the output file into
+average rates/fluxes/populations with confidence intervals.
+
+-----------------------------------------------------------------------------
+Output format
+-----------------------------------------------------------------------------
+
+The output file (-o/--output, by default "direct.h5") contains the
+following datasets:
+
+  ``/conditional_fluxes`` [iteration][state][state]
+    *(Floating-point)* Macrostate-to-macrostate fluxes. These are **not**
+    normalized by the population of the initial macrostate.
+
+  ``/conditional_arrivals`` [iteration][stateA][stateB]
+    *(Integer)* Number of trajectories arriving at state *stateB* in a given
+    iteration, given that they departed from *stateA*.
+
+  ``/total_fluxes`` [iteration][state]
+    *(Floating-point)* Total flux into a given macrostate.
+
+  ``/arrivals`` [iteration][state]
+    *(Integer)* Number of trajectories arriving at a given state in a given
+    iteration, regardless of where they originated.
+
+  ``/duration_count`` [iteration]
+    *(Integer)* The number of event durations recorded in each iteration.
+
+  ``/durations`` [iteration][event duration]
+    *(Structured -- see below)*  Event durations for transition events ending
+    during a given iteration. These are stored as follows:
+
+      istate
+        *(Integer)* Initial state of transition event.
+      fstate
+        *(Integer)* Final state of transition event.
+      duration
+        *(Floating-point)* Duration of transition, in units of tau.
+      weight
+        *(Floating-point)* Weight of trajectory at end of transition, **not**
+        normalized by initial state population.
+
+Because state-to-state fluxes stored in this file are not normalized by
+initial macrostate population, they cannot be used as rates without further
+processing. The ``w_direct kinetics`` command is used to perform this normalization
+while taking statistical fluctuation and correlation into account. See
+``w_direct kinetics --help`` for more information.  Target fluxes (total flux
+into a given state) require no such normalization.
+
+-----------------------------------------------------------------------------
+Command-line options
+-----------------------------------------------------------------------------
+'''
+
+    def __init__(self, parent):
+        super().__init__(parent)
+
+    def open_files(self):
+        self.output_file = h5io.WESTPAH5File(self.output_filename, 'a', creating_program=True)
+        h5io.stamp_creator_data(self.output_file)
+        self.assignments_file = h5io.WESTPAH5File(self.assignments_filename, 'r')  # , driver='core', backing_store=False)
+        if not self.iter_range.check_data_iter_range_least(self.assignments_file):
+            raise ValueError('assignments data do not span the requested iterations')
+
+    def go(self):
+        pi = self.progress.indicator
+        with pi:
+            self.w_kinetics()
+
+
+# The old w_kinavg
+class DKinAvg(AverageCommands):
+    subcommand = 'kinetics'
+    help_text = 'Generates rate and flux values from a WESTPA simulation via tracing.'
+    default_kinetics_file = 'direct.h5'
+    description = '''\
+Calculate average rates/fluxes and associated errors from weighted ensemble
+data. Bin assignments (usually "assign.h5") and kinetics data (usually
+"direct.h5") data files must have been previously generated (see
+"w_assign --help" and "w_direct init --help" for information on
+generating these files).
+
+The evolution of all datasets may be calculated, with or without confidence
+intervals.
+
+-----------------------------------------------------------------------------
+Output format
+-----------------------------------------------------------------------------
+
+The output file (-o/--output, usually "direct.h5") contains the following
+dataset:
+
+  /avg_rates [state,state]
+    (Structured -- see below) State-to-state rates based on entire window of
+    iterations selected.
+
+  /avg_total_fluxes [state]
+    (Structured -- see below) Total fluxes into each state based on entire
+    window of iterations selected.
+
+  /avg_conditional_fluxes [state,state]
+    (Structured -- see below) State-to-state fluxes based on entire window of
+    iterations selected.
+
+If --evolution-mode is specified, then the following additional datasets are
+available:
+
+  /rate_evolution [window][state][state]
+    (Structured -- see below). State-to-state rates based on windows of
+    iterations of varying width.  If --evolution-mode=cumulative, then
+    these windows all begin at the iteration specified with
+    --start-iter and grow in length by --step-iter for each successive
+    element. If --evolution-mode=blocked, then these windows are all of
+    width --step-iter (excluding the last, which may be shorter), the first
+    of which begins at iteration --start-iter.
+
+  /target_flux_evolution [window,state]
+    (Structured -- see below). Total flux into a given macro state based on
+    windows of iterations of varying width, as in /rate_evolution.
+
+  /conditional_flux_evolution [window,state,state]
+    (Structured -- see below). State-to-state fluxes based on windows of
+    varying width, as in /rate_evolution.
+
+The structure of these datasets is as follows:
+
+  iter_start
+    (Integer) Iteration at which the averaging window begins (inclusive).
+
+  iter_stop
+    (Integer) Iteration at which the averaging window ends (exclusive).
+
+  expected
+    (Floating-point) Expected (mean) value of the observable as evaluated within
+    this window, in units of inverse tau.
+
+  ci_lbound
+    (Floating-point) Lower bound of the confidence interval of the observable
+    within this window, in units of inverse tau.
+
+  ci_ubound
+    (Floating-point) Upper bound of the confidence interval of the observable
+    within this window, in units of inverse tau.
+
+  stderr
+    (Floating-point) The standard error of the mean of the observable
+    within this window, in units of inverse tau.
+
+  corr_len
+    (Integer) Correlation length of the observable within this window, in units
+    of tau.
+
+Each of these datasets is also stamped with a number of attributes:
+
+  mcbs_alpha
+    (Floating-point) Alpha value of confidence intervals. (For example,
+    *alpha=0.05* corresponds to a 95% confidence interval.)
+
+  mcbs_nsets
+    (Integer) Number of bootstrap data sets used in generating confidence
+    intervals.
+
+  mcbs_acalpha
+    (Floating-point) Alpha value for determining correlation lengths.
+
+
+-----------------------------------------------------------------------------
+Command-line options
+-----------------------------------------------------------------------------
+'''
+
+    def w_kinavg(self):
+        pi = self.progress.indicator
+        # pi = None
+
+        # We're initializing the various datasets...
+        self.open_files()
+        self.open_assignments()
+        # Obviously, this is for the conditional and total fluxes.  This is really all we need to sort for this.
+        cond_fluxes = h5io.IterBlockedDataset(self.kinetics_file['conditional_fluxes'])
+        cond_fluxes.cache_data()
+        total_fluxes = h5io.IterBlockedDataset(self.kinetics_file['total_fluxes'])
+
+        # This is necessary for both color and state populations...
+        # ... but we also need this for the kinetics calculations.
+        pops = h5io.IterBlockedDataset(self.assignments_file['labeled_populations'])
+        pops.cache_data()
+        pops.data = pops.data.sum(axis=2)
+
+        submit_kwargs = dict(
+            pi=pi, nstates=self.nstates, start_iter=self.start_iter, stop_iter=self.stop_iter, step_iter=self.step_iter
+        )
+
+        # Calculate averages for the simulation, then report, if necessary.
+
+        submit_kwargs['dataset'] = {'dataset': cond_fluxes, 'pops': pops}
+        avg_rates = self.run_calculation(
+            eval_block=_rate_eval_block, name='Rate Evolution', dim=2, do_averages=True, **submit_kwargs
+        )
+        self.output_file.replace_dataset('avg_rates', data=avg_rates[1])
+
+        submit_kwargs['dataset'] = {'dataset': cond_fluxes}
+        avg_conditional_fluxes = self.run_calculation(
+            eval_block=_2D_simple_eval_block, name='Conditional Flux Evolution', dim=2, do_averages=True, **submit_kwargs
+        )
+        self.output_file.replace_dataset('avg_conditional_fluxes', data=avg_conditional_fluxes[1])
+
+        submit_kwargs['dataset'] = {'dataset': total_fluxes}
+        avg_total_fluxes = self.run_calculation(
+            eval_block=_1D_simple_eval_block, name='Target Flux Evolution', dim=1, do_averages=True, **submit_kwargs
+        )
+        self.output_file.replace_dataset('avg_total_fluxes', data=avg_total_fluxes[1])
+
+        # Now, print them!
+
+        # We've returned an average, but it still exists in a timeslice format.  So we need to return the 'last' value.
+        if self.display_averages:
+            self.print_averages(avg_total_fluxes[1], '\nfluxes into macrostates:', dim=1)
+            self.print_averages(avg_conditional_fluxes[1], '\nfluxes from state to state:', dim=2)
+            self.print_averages(avg_rates[1], '\nrates from state to state:', dim=2)
+
+        # Do a bootstrap evolution.
+        submit_kwargs['dataset'] = {'dataset': cond_fluxes, 'pops': pops}
+        rate_evol = self.run_calculation(eval_block=_rate_eval_block, name='Rate Evolution', dim=2, **submit_kwargs)
+        self.output_file.replace_dataset('rate_evolution', data=rate_evol, shuffle=True, compression=9)
+
+        submit_kwargs['dataset'] = {'dataset': cond_fluxes}
+        rate_evol = self.run_calculation(
+            eval_block=_2D_simple_eval_block, name='Conditional Flux Evolution', dim=2, **submit_kwargs
+        )
+        self.output_file.replace_dataset('conditional_flux_evolution', data=rate_evol, shuffle=True, compression=9)
+
+        submit_kwargs['dataset'] = {'dataset': total_fluxes}
+        rate_evol = self.run_calculation(eval_block=_1D_simple_eval_block, name='Target Flux Evolution', dim=1, **submit_kwargs)
+        self.output_file.replace_dataset('target_flux_evolution', data=rate_evol, shuffle=True, compression=9)
+
+    def go(self):
+        # Have class inherit user-provided self.output_filename as self.kinetics_filename
+        self.kinetics_filename = self.output_filename
+
+        pi = self.progress.indicator
+        with pi:
+            self.w_kinavg()
+
+
+# The old w_stateprobs
+class DStateProbs(AverageCommands):
+    subcommand = 'probs'
+    help_text = 'Calculates color and state probabilities via tracing.'
+    default_kinetics_file = 'direct.h5'
+    description = '''\
+Calculate average populations and associated errors in state populations from
+weighted ensemble data. Bin assignments, including macrostate definitions,
+are required. (See "w_assign --help" for more information).
+
+-----------------------------------------------------------------------------
+Output format
+-----------------------------------------------------------------------------
+
+The output file (-o/--output, usually "direct.h5") contains the following
+dataset:
+
+  /avg_state_probs [state]
+    (Structured -- see below) Population of each state across entire
+    range specified.
+
+  /avg_color_probs [state]
+    (Structured -- see below) Population of each ensemble across entire
+    range specified.
+
+If --evolution-mode is specified, then the following additional datasets are
+available:
+
+  /state_pop_evolution [window][state]
+    (Structured -- see below). State populations based on windows of
+    iterations of varying width.  If --evolution-mode=cumulative, then
+    these windows all begin at the iteration specified with
+    --start-iter and grow in length by --step-iter for each successive
+    element. If --evolution-mode=blocked, then these windows are all of
+    width --step-iter (excluding the last, which may be shorter), the first
+    of which begins at iteration --start-iter.
+
+  /color_prob_evolution [window][state]
+    (Structured -- see below). Ensemble populations based on windows of
+    iterations of varying width.  If --evolution-mode=cumulative, then
+    these windows all begin at the iteration specified with
+    --start-iter and grow in length by --step-iter for each successive
+    element. If --evolution-mode=blocked, then these windows are all of
+    width --step-iter (excluding the last, which may be shorter), the first
+    of which begins at iteration --start-iter.
+
+The structure of these datasets is as follows:
+
+  iter_start
+    (Integer) Iteration at which the averaging window begins (inclusive).
+
+  iter_stop
+    (Integer) Iteration at which the averaging window ends (exclusive).
+
+  expected
+    (Floating-point) Expected (mean) value of the observable as evaluated within
+    this window, in units of inverse tau.
+
+  ci_lbound
+    (Floating-point) Lower bound of the confidence interval of the observable
+    within this window, in units of inverse tau.
+
+  ci_ubound
+    (Floating-point) Upper bound of the confidence interval of the observable
+    within this window, in units of inverse tau.
+
+  stderr
+    (Floating-point) The standard error of the mean of the observable
+    within this window, in units of inverse tau.
+
+  corr_len
+    (Integer) Correlation length of the observable within this window, in units
+    of tau.
+
+Each of these datasets is also stamped with a number of attributes:
+
+  mcbs_alpha
+    (Floating-point) Alpha value of confidence intervals. (For example,
+    *alpha=0.05* corresponds to a 95% confidence interval.)
+
+  mcbs_nsets
+    (Integer) Number of bootstrap data sets used in generating confidence
+    intervals.
+
+  mcbs_acalpha
+    (Floating-point) Alpha value for determining correlation lengths.
+
+
+-----------------------------------------------------------------------------
+Command-line options
+-----------------------------------------------------------------------------
+'''
+
+    def calculate_state_populations(self, pops):
+        # ... but then this is how the state populations are done.
+        # This was taken, more or less, from the old w_stateprobs
+        iter_count = self.stop_iter - self.start_iter
+        all_state_pops = np.empty((iter_count, self.nstates + 1), weight_dtype)
+        iter_state_pops = np.empty((self.nstates + 1,), weight_dtype)
+        avg_state_pops = np.zeros((self.nstates + 1,), weight_dtype)
+        pops.cache_data(max_size='available')
+        state_map = self.assignments_file['state_map'][...]
+        try:
+            for iiter, n_iter in enumerate(range(self.start_iter, self.stop_iter)):
+                iter_state_pops.fill(0)
+                labeled_pops = pops.iter_entry(n_iter)
+                accumulate_state_populations_from_labeled(labeled_pops, state_map, iter_state_pops, check_state_map=False)
+                all_state_pops[iiter] = iter_state_pops
+                avg_state_pops += iter_state_pops
+                del labeled_pops
+        finally:
+            pops.drop_cache()
+
+        state_pops = h5io.IterBlockedDataset.empty_like(pops)
+        state_pops.data = all_state_pops
+        return state_pops
+
+    def w_stateprobs(self):
+        pi = self.progress.indicator
+
+        self.open_files()
+        self.open_assignments()
+        # So far, we definitely need this boilerplate...
+        # pi.new_operation('Reading data')
+
+        # This is necessary for both color and state populations...
+        pops = h5io.IterBlockedDataset(self.assignments_file['labeled_populations'])
+
+        state_pops = self.calculate_state_populations(pops)
+
+        # This now sorts it for the color populations
+        pops.cache_data()
+        pops.data = pops.data.sum(axis=2)
+
+        submit_kwargs = dict(
+            pi=pi,
+            nstates=self.nstates,
+            start_iter=self.start_iter,
+            stop_iter=self.stop_iter,
+            step_iter=self.step_iter,
+            eval_block=_1D_simple_eval_block,
+        )
+
+        # Calculate and print averages
+        submit_kwargs['dataset'] = {'dataset': pops}
+        color_evol_avg = self.run_calculation(name='Color Probability Evolution', dim=1, do_averages=True, **submit_kwargs)
+        self.output_file.replace_dataset('avg_color_probs', data=color_evol_avg[1], shuffle=True, compression=9)
+
+        submit_kwargs['dataset'] = {'dataset': state_pops}
+        state_evol_avg = self.run_calculation(name='State Probability Evolution', dim=1, do_averages=True, **submit_kwargs)
+        self.output_file.replace_dataset(name='avg_state_probs', data=state_evol_avg[1], shuffle=True, compression=9)
+
+        # Print!
+        if self.display_averages:
+            self.print_averages(color_evol_avg[1], '\naverage color probabilities:', dim=1)
+            self.print_averages(state_evol_avg[1], '\naverage state probabilities:', dim=1)
+
+        # Now, do a bootstrap evolution
+        submit_kwargs['dataset'] = {'dataset': pops}
+        pop_evol = self.run_calculation(name='Color Probability Evolution', dim=1, **submit_kwargs)
+        self.output_file.replace_dataset('color_prob_evolution', data=pop_evol, shuffle=True, compression=9)
+
+        submit_kwargs['dataset'] = {'dataset': state_pops}
+        pop_evol = self.run_calculation(name='State Probability Evolution', dim=1, **submit_kwargs)
+        self.output_file.replace_dataset(name='state_pop_evolution', data=pop_evol, shuffle=True, compression=9)
+
+    def go(self):
+        # Have class inherit user-provided self.output_filename as self.kinetics_filename
+        self.kinetics_filename = self.output_filename
+
+        pi = self.progress.indicator
+        with pi:
+            self.w_stateprobs()
+
+
+# Just a convenience class to run everything.
+class DAll(DStateProbs, DKinAvg, DKinetics):
+    subcommand = 'all'
+    help_text = 'Runs the full suite, including the tracing of events.'
+    default_kinetics_file = 'direct.h5'
+    description = '''\
+A convenience function to run init/kinetics/probs. Bin assignments,
+including macrostate definitions, are required. (See
+"w_assign --help" for more information).
+
+For more information on the individual subcommands this subs in for, run
+w_direct {init/kinetics/probs} --help.
+
+-----------------------------------------------------------------------------
+Command-line options
+-----------------------------------------------------------------------------
+'''
+
+    def go(self):
+        # Have class inherit user-provided self.output_filename as self.kinetics_filename
+        self.kinetics_filename = self.output_filename
+
+        pi = self.progress.indicator
+        with pi:
+            self.w_kinetics()
+            self.w_kinavg()
+            self.w_stateprobs()
+
+
+# Just a convenience class to average the observables.
+class DAverage(DStateProbs, DKinAvg):
+    subcommand = 'average'
+    help_text = 'Averages and returns fluxes, rates, and color/state populations.'
+    default_kinetics_file = 'direct.h5'
+    description = '''\
+A convenience function to run kinetics/probs. Bin assignments,
+including macrostate definitions, are required. (See
+"w_assign --help" for more information).
+
+For more information on the individual subcommands this subs in for, run
+w_direct {kinetics/probs} --help.
+
+-----------------------------------------------------------------------------
+Command-line options
+-----------------------------------------------------------------------------
+'''
+
+    def go(self):
+        # Have class inherit user-provided self.output_filename as self.kinetics_filename
+        self.kinetics_filename = self.output_filename
+
+        pi = self.progress.indicator
+        with pi:
+            self.w_kinavg()
+            self.w_stateprobs()
+
+
+class WDirect(WESTMasterCommand, WESTParallelTool):
+    prog = 'w_direct'
+    # subcommands = [AvgTraceSubcommand,AvgMatrixSubcommand]
+    subcommands = [DKinetics, DAverage, DKinAvg, DStateProbs, DAll]
+    subparsers_title = 'direct kinetics analysis schemes'
+
+
+def entry_point():
+    WDirect().main()
+
+
+if __name__ == '__main__':
+    entry_point()

westpa/cli/tools/w_dumpsegs.py

@@ -0,0 +1,94 @@
+import logging
+import sys
+
+from warnings import warn
+from westpa.tools import WESTTool, WESTDataReader
+from westpa.core.segment import Segment
+
+log = logging.getLogger('w_dumpsegs')
+
+
+class WDumpSegs(WESTTool):
+    prog = 'w_dumpsegs'
+    description = '''\
+Dump segment data as text. This is very inefficient, so this tool should be used
+as a last resort (use hdfview/h5ls to look at data, and access HDF5 directly for
+significant analysis tasks).
+'''
+
+    def __init__(self):
+        super().__init__()
+        self.data_reader = WESTDataReader()
+        self.n_iter = None
+        self.output_file = None
+        self.print_pcoords = False
+
+    def add_args(self, parser):
+        self.data_reader.add_args(parser)
+
+        parser.add_argument(
+            '-p',
+            '--print-pcoords',
+            dest='print_pcoords',
+            action='store_true',
+            help='print initial and final progress coordinates for each segment',
+        )
+        parser.add_argument(
+            '-i', '--iteration', dest='n_iter', type=int, help='Use data from iteration N_ITER (default: last complete iteration)'
+        )
+        parser.add_argument(
+            '-o', '--output', dest='output_file', help='Store output in OUTPUT_FILE (default: write to standard output).'
+        )
+
+    def process_args(self, args):
+        self.data_reader.process_args(args)
+        self.data_reader.open()
+        self.n_iter = args.n_iter or self.data_reader.current_iteration - 1
+        self.output_file = open(args.output_file, 'wt') if args.output_file else sys.stdout
+        self.print_pcoords = args.print_pcoords
+
+    def go(self):
+        segments = self.data_reader.get_segments(self.n_iter)
+
+        max_seg_id_len = len(str(max(segment.seg_id for segment in segments)))
+        max_status_name_len = max(list(map(len, iter(Segment.status_names.values()))))
+        max_endpoint_type_len = max(list(map(len, iter(Segment.endpoint_type_names.values()))))
+        max_n_parents_len = len(str(max(len(segment.wtg_parent_ids) for segment in segments)))
+
+        report_line = (
+            '{segment.n_iter:d}  {segment.seg_id:{max_seg_id_len}d}  {segment.weight:20.14g}'
+            + '  {status_name:{max_status_name_len}s} ({segment.status})'
+            + '  {segment.walltime:<12.6g} {segment.cputime:<12.6g}'
+            + '  {endpoint_type_name:{max_endpoint_type_len}s} ({segment.endpoint_type})'
+            + '  {n_parents:{max_n_parents_len}d} {segment.parent_id:{max_seg_id_len}d} {parents_str}'
+            + '\n'
+        )
+        pcoord_lines = '  pcoord[0]  = {init_pcoord}\n  pcoord[-1] = {final_pcoord}' + '\n'
+        for _seg_id, segment in enumerate(segments):
+            parents_str = '[' + ', '.join(map(str, sorted(segment.wtg_parent_ids))) + ']'
+            init_pcoord_str = '[' + ', '.join('{pcval:<12.6g}'.format(pcval=float(pce)) for pce in segment.pcoord[0]) + ']'
+            final_pcoord_str = '[' + ', '.join('{pcval:<12.6g}'.format(pcval=float(pce)) for pce in segment.pcoord[-1]) + ']'
+            self.output_file.write(
+                report_line.format(
+                    segment=segment,
+                    status_name=segment.status_names[segment.status],
+                    endpoint_type_name=segment.endpoint_type_names[segment.endpoint_type],
+                    parents_str=parents_str,
+                    n_parents=len(segment.wtg_parent_ids),
+                    max_seg_id_len=max_seg_id_len,
+                    max_status_name_len=max_status_name_len,
+                    max_endpoint_type_len=max_endpoint_type_len,
+                    max_n_parents_len=max_n_parents_len,
+                )
+            )
+            if self.print_pcoords:
+                self.output_file.write(pcoord_lines.format(init_pcoord=init_pcoord_str, final_pcoord=final_pcoord_str))
+
+
+def entry_point():
+    warn('w_dumpsegs is being deprecated.')
+    WDumpSegs().main()
+
+
+if __name__ == '__main__':
+    entry_point()