NT_branchAnalysis.cxx

Go to the documentation of this file.

// ============================================================== //
//                                                                //
//   File      : NT_branchAnalysis.cxx                            //
//   Purpose   :                                                  //
//                                                                //
//   Coded by Ralf Westram (coder@reallysoft.de) in August 2012   //
//   Institute of Microbiology (Technical University Munich)      //
//   http://www.arb-home.de/                                      //
//                                                                //
// ============================================================== //

#include "NT_local.h"
#include <TreeCallbacks.hxx>
#include <aw_awar.hxx>
#include <aw_msg.hxx>
#include <aw_root.hxx>
#include <config_manager.hxx>

#define AWAR_BRANCH_ANALYSIS     "branch_analysis"
#define AWAR_BRANCH_ANALYSIS_TMP "tmp/" AWAR_BRANCH_ANALYSIS

#define AWAR_BA_MIN_REL_DIFF AWAR_BRANCH_ANALYSIS "/min_rel_diff"
#define AWAR_BA_MIN_ABS_DIFF AWAR_BRANCH_ANALYSIS "/min_abs_diff"
#define AWAR_BA_MIN_DEPTH    AWAR_BRANCH_ANALYSIS "/min_depth"
#define AWAR_BA_MIN_ROOTDIST AWAR_BRANCH_ANALYSIS "/min_rootdist"
#define AWAR_BA_DEGENERATION AWAR_BRANCH_ANALYSIS "/degeneration"

#define AWAR_BA_AUTOMARK_FORMAT AWAR_BRANCH_ANALYSIS_TMP "/auto_%s"

// AISC_MKPT_PROMOTE:class TREE_canvas;

class BranchWindow : virtual Noncopyable {
    TREE_canvas      *ntw;
    char             *suffix;
    AW_awar          *awar_info;
    AW_window_simple *aws;

    static char *get_suffix(TREE_canvas *ntw) {
        // suffix depends on canvas
        return GBS_global_string_copy("_%i", ntw->get_index());
    }

    const char *local_awar_name (const char *prefix, const char *name) { return GBS_global_string("%s%s/%s", prefix, suffix, name); }

    void create_awars(AW_root *aw_root);
    void create_window(AW_root *aw_root);

    const char *automark_awarname() const { return GBS_global_string(AWAR_BA_AUTOMARK_FORMAT, suffix); }

public:
    BranchWindow(AW_root *aw_root, TREE_canvas *ntw_)
        : ntw(ntw_),
          suffix(get_suffix(ntw))
    {
        create_awars(aw_root);
        create_window(aw_root);
    }

    ~BranchWindow() {
        free(suffix);
    }

    AW_window *get_window() const { return aws; }

private:
    AW_root *get_awroot() const { return get_window()->get_root(); }
    TREE_canvas *get_canvas() const { return ntw; }
    AP_tree *get_tree() const { return AWT_TREE(ntw)->get_root_node(); }
    GBDATA *get_gbmain() const { return get_canvas()->gb_main; }
    AW_awar *awar(const char *name) { return get_awroot()->awar(name); }

    void postmark_action() const {
        AWT_auto_refresh allowed_on(get_canvas());
        get_canvas()->request_structure_update();
    }

    bool have_tree() {
        if (get_tree()) return true;
        set_info("No tree selected");
        return false;
    }

    static void adapt_intawar_max(AW_awar *awar, int val, int extra) { // @@@ move to AW_awar?
        // adapt maximum defined for int-awar (according to encountered maximum 'val' + a bit 'extra' range)
        nt_assert(awar->get_type() == AW_INT);

        int max = awar->get_max();
        if (max<val || ((val*2) < max && awar->get_min()<val)) {
            awar->set_max(val+extra);
        }
    }
    static void adapt_floatawar_max(AW_awar *awar, double val, double extra) { // @@@ move to AW_awar?
        // adapt maximum defined for float-awar (according to encountered maximum 'val' + a bit 'extra' range)
        nt_assert(awar->get_type() == AW_FLOAT);

        double max = awar->get_max();
        if (max<val || ((val*2) < max && awar->get_min()<val)) {
            awar->set_max(val+extra);
        }
    }

public:
    void set_info(const char *msg) const { awar_info->write_string(msg); }
    void unmark_all() const { NT_mark_all_cb(NULp, get_canvas(), 0); }

    AW_awar *automark_awar() const { return get_awroot()->awar(automark_awarname()); }
    bool has_automark_set() const { return automark_awar()->read_int(); }

    void markDegeneratedBranches() {
        if (have_tree()) {
            GB_transaction ta(get_gbmain());

            AW_awar *awar_degen          = awar(AWAR_BA_DEGENERATION);
            double   degeneration_factor = awar_degen->read_float();

            unmark_all();

            double found_max_degeneration = get_tree()->mark_degenerated_branches(degeneration_factor);
            set_info(GBS_global_string("Maximum degeneration = %.2f", found_max_degeneration));
            adapt_floatawar_max(awar_degen, found_max_degeneration, 1.0);

            postmark_action();
        }
    }
    void markDeepLeafs() {
        if (have_tree()) {
            GB_transaction ta(get_gbmain());

            AW_awar *awar_min_depth    = awar(AWAR_BA_MIN_DEPTH);
            AW_awar *awar_min_rootdist = awar(AWAR_BA_MIN_ROOTDIST);
            int      min_depth         = awar_min_depth->read_int();
            double   min_rootdist      = awar_min_rootdist->read_float();
            int      found_max_depth;
            double   found_max_rootdist;

            unmark_all();
            set_info(get_tree()->mark_deep_leafs(min_depth, min_rootdist, found_max_depth, found_max_rootdist));
            adapt_intawar_max(awar_min_depth, found_max_depth, 1);
            adapt_floatawar_max(awar_min_rootdist, found_max_rootdist, 0.1);
            postmark_action();
        }
    }
    void markLongBranches() {
        if (have_tree()) {
            GB_transaction ta(get_gbmain());

            AW_awar *awar_abs_diff = awar(AWAR_BA_MIN_ABS_DIFF);
            double   min_rel_diff  = awar(AWAR_BA_MIN_REL_DIFF)->read_float()/100.0;
            double   min_abs_diff  = awar_abs_diff->read_float();
            double   found_max_abs_diff;

            unmark_all();
            set_info(get_tree()->mark_long_branches(min_rel_diff, min_abs_diff, found_max_abs_diff));
            adapt_floatawar_max(awar_abs_diff, found_max_abs_diff, 0.1);
            postmark_action();
        }
    }

    void analyseDistances() {
        if (have_tree()) {
            GB_transaction ta(get_gbmain());
            set_info(get_tree()->analyse_distances());
        }
    }
};

static BranchWindow *existingBranchWindow[MAX_NT_WINDOWS] = { MAX_NT_WINDOWS_NULLINIT };

// --------------------------------------------------------------------------------

static void mark_long_branches_cb       (AW_window*, BranchWindow *bw) { bw->markLongBranches(); }
static void mark_deep_leafs_cb          (AW_window*, BranchWindow *bw) { bw->markDeepLeafs(); }
static void mark_degenerated_branches_cb(AW_window*, BranchWindow *bw) { bw->markDegeneratedBranches(); }
static void unmark_branches_cb          (AW_window*, BranchWindow *bw) { bw->unmark_all(); }
static void distance_analysis_cb        (AW_window*, BranchWindow *bw) { bw->analyseDistances(); }

static void tree_changed_cb             (AW_root*,   BranchWindow *bw) { bw->set_info("<tree has changed>"); }

static BranchWindow *findAutomarkingBranchWindow() {
    for (int w = 0; w<MAX_NT_WINDOWS; ++w) {
        BranchWindow *bw = existingBranchWindow[w];
        if (bw && bw->has_automark_set()) {
            return bw;
        }
    }
    return NULp;
}

static void mark_long_branches_automark_cb() {
    BranchWindow *bw = findAutomarkingBranchWindow();
    if (bw) bw->markLongBranches();
}
static void mark_deep_leafs_automark_cb() {
    BranchWindow *bw = findAutomarkingBranchWindow();
    if (bw) bw->markDeepLeafs();
}
static void mark_degenerated_branches_automark_cb() {
    BranchWindow *bw = findAutomarkingBranchWindow();
    if (bw) bw->markDegeneratedBranches();
}

static void automark_changed_cb(AW_root *, BranchWindow *bw) {
    static bool avoid_recursion = false;
    if (!avoid_recursion) {
        AW_awar *awar_automark = bw->automark_awar();
        if (awar_automark->read_int()) { // just activated
            LocallyModify<bool> avoid(avoid_recursion, true);

            awar_automark->write_int(0);
            BranchWindow *prev_active = findAutomarkingBranchWindow();
            if (prev_active) prev_active->automark_awar()->write_int(0);
            awar_automark->write_int(1);
        }
    }
}

void BranchWindow::create_awars(AW_root *aw_root) {
    awar_info = aw_root->awar_string(local_awar_name(AWAR_BRANCH_ANALYSIS_TMP, "info"), "<No analysis performed yet>");
    ntw->get_awar_tree()->add_callback(makeRootCallback(tree_changed_cb, this));

    aw_root->awar_float(AWAR_BA_MIN_REL_DIFF, 75)->set_minmax(0, 100)->add_callback(makeRootCallback(mark_long_branches_automark_cb));
    aw_root->awar_float(AWAR_BA_MIN_ABS_DIFF, 0.01)->set_minmax(0, 20)->add_callback(makeRootCallback(mark_long_branches_automark_cb));

    aw_root->awar_int(AWAR_BA_MIN_DEPTH, 0)->set_minmax(0, 50)->add_callback(makeRootCallback(mark_deep_leafs_automark_cb));
    aw_root->awar_float(AWAR_BA_MIN_ROOTDIST, 0.9)->set_minmax(0, 20)->add_callback(makeRootCallback(mark_deep_leafs_automark_cb));

    aw_root->awar_float(AWAR_BA_DEGENERATION, 30)->set_minmax(0, 100)->add_callback(makeRootCallback(mark_degenerated_branches_automark_cb));
}

static AWT_config_mapping_def branch_analysis_config_mapping[] = {
    { AWAR_BA_MIN_REL_DIFF, "minreldiff" },
    { AWAR_BA_MIN_ABS_DIFF, "minabsdiff" },
    { AWAR_BA_MIN_DEPTH,    "mindepth" },
    { AWAR_BA_MIN_ROOTDIST, "minrootdist" },
    { AWAR_BA_DEGENERATION, "degeneration" },

    { NULp, NULp }
};

void BranchWindow::create_window(AW_root *aw_root) {
    aws = new AW_window_simple;

    aws->init(aw_root, GBS_global_string("BRANCH_ANALYSIS_%s", suffix), "Branch analysis");
    aws->load_xfig("ad_branch.fig");

    aws->auto_space(5, 5);

    aws->at("close");
    aws->callback(AW_POPDOWN);
    aws->create_button("CLOSE", "CLOSE", "C");

    aws->at("help");
    aws->callback(makeHelpCallback("branch_analysis.hlp"));
    aws->create_button("HELP", "HELP", "H");

    AW_awar *awar_automark = aw_root->awar_int(automark_awarname(), 0);
    aws->at("auto");
    aws->label("Auto mark?");
    aws->create_toggle(awar_automark->awar_name);
    awar_automark->add_callback(makeRootCallback(automark_changed_cb, this));

    aws->at("sel");
    aws->create_button(NULp, ntw->get_awar_tree()->awar_name, NULp, "+");

    aws->at("info");
    aws->create_text_field(awar_info->awar_name);

    aws->button_length(28);

    aws->at("dist_analyse");
    aws->callback(makeWindowCallback(distance_analysis_cb, this));
    aws->create_button("ANALYSE", "Analyse distances in tree");

    aws->at("unmark");
    aws->callback(makeWindowCallback(unmark_branches_cb, this));
    aws->create_button("UNMARK", "Unmark all species");

    const int FIELDWIDTH  = 10;
    const int SCALERWIDTH = 250;

    aws->at("mark_long");
    aws->callback(makeWindowCallback(mark_long_branches_cb, this));
    aws->create_button("MARK_LONG", "Mark long branches");

    aws->at("min_rel"); aws->create_input_field_with_scaler(AWAR_BA_MIN_REL_DIFF, FIELDWIDTH, SCALERWIDTH, AW_SCALER_LINEAR);
    aws->at("min_abs"); aws->create_input_field_with_scaler(AWAR_BA_MIN_ABS_DIFF, FIELDWIDTH, SCALERWIDTH, AW_SCALER_EXP_LOWER);


    aws->at("mark_deep");
    aws->callback(makeWindowCallback(mark_deep_leafs_cb, this));
    aws->create_button("MARK_DEEP", "Mark deep leafs");

    aws->at("tree_depth");   aws->create_input_field_with_scaler(AWAR_BA_MIN_DEPTH,    FIELDWIDTH, SCALERWIDTH, AW_SCALER_EXP_LOWER);
    aws->at("branch_depth"); aws->create_input_field_with_scaler(AWAR_BA_MIN_ROOTDIST, FIELDWIDTH, SCALERWIDTH, AW_SCALER_EXP_LOWER);

    aws->at("mark_degen");
    aws->callback(makeWindowCallback(mark_degenerated_branches_cb, this));
    aws->create_button("MARK_DEGENERATED", "Mark degenerated branches");

    aws->at("degen"); aws->create_input_field_with_scaler(AWAR_BA_DEGENERATION, FIELDWIDTH, SCALERWIDTH, AW_SCALER_EXP_LOWER);

    aws->at("config");
    AWT_insert_config_manager(aws, AW_ROOT_DEFAULT, "branch_analysis", branch_analysis_config_mapping);
}

AW_window *NT_create_branch_analysis_window(AW_root *aw_root, TREE_canvas *ntw) {
    int ntw_id = ntw->get_index();
    if (!existingBranchWindow[ntw_id]) {
        existingBranchWindow[ntw_id] = new BranchWindow(aw_root, ntw);
    }
    nt_assert(existingBranchWindow[ntw_id]);
    return existingBranchWindow[ntw_id]->get_window();
}