ShapeWorks/Libs/Project/Subject.h at fb5698bb2be9fdc2afc476c878ad73f44fad3d4f · SCIInstitute/ShapeWorks · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
#pragma once

#include <Libs/Optimize/Domain/DomainType.h>

#include <map>
#include <string>
#include <vector>

#include "ProjectUtils.h"

namespace shapeworks {

//! Representation of a single subject.
/*!
 * The Subject class encapsulates one "sample" in the shapeworks system (e.g. one row in a spreadsheet project)
 * A Subject may have multiple segmentations/domains associated with it.
 *
 */
class Subject {
 public:
  using StringMap = project::types::StringMap;
  using StringList = project::types::StringList;

  Subject();
  ~Subject();

  //! Set original filenames (one per domain)
  void set_original_filenames(StringList filenames);
  //! Get original filenames
  StringList get_original_filenames();

  //! Set groomed filenames
  void set_groomed_filenames(StringList filenames);
  //! Get groomed filenames
  StringList get_groomed_filenames();

  //! Set local particle filenames (one per domain)
  void set_local_particle_filenames(StringList filenames);
  //! Get local particle filenames
  StringList get_local_particle_filenames();

  //! Set the world particle filenames
  void set_world_particle_filenames(StringList filenames);
  //! Get the world particle filenames
  StringList get_world_particle_filenames();

  //! Get the landmarks filenames (one per domain)
  void set_landmarks_filenames(StringList filenames);
  //! Set the landmarks filenames
  StringList get_landmarks_filenames();

  //! Get the constraints filenames (one per domain)
  void set_constraints_filenames(StringList filenames);
  //! Set the constratins filenames
  StringList get_constraints_filenames();

  //! Set the number of domains
  void set_number_of_domains(int number_of_domains);
  //! Get the number of domains
  int get_number_of_domains();

  //! Get the feature map filenames
  StringMap get_feature_filenames() const;
  //! Set the feature map filenames
  void set_feature_filenames(const StringMap& feature_filenames);

  //! Get the groomed transforms (one vector per domain)
  std::vector<std::vector<double>> get_groomed_transforms() const;
  //! Set the groomed transforms (one vector per domain)
  void set_groomed_transforms(std::vector<std::vector<double>> transforms);
  //! Set the i-th groomed transform
  void set_groomed_transform(int i, std::vector<double> transform);

  //! Get the procrustes transforms (one vector per domain)
  std::vector<std::vector<double>> get_procrustes_transforms() const;
  //! Set the procrustes transforms (one vector per domain)
  void set_procrustes_transforms(std::vector<std::vector<double>> transforms);

  //! Get the group values
  StringMap get_group_values() const;
  //! Get a specific group value
  std::string get_group_value(std::string group_name);

  //! Set the group values
  void set_group_values(const StringMap& group_values);

  //! Get extra values (extra columns we don't interpret)
  StringMap get_extra_values() const;
  void set_extra_values(StringMap extra_values);

  //! Get all table values
  StringMap get_table_values() const;
  void set_table_values(StringMap table_values);

  //! Get the display name
  std::string get_display_name();
  //! Set the display name
  void set_display_name(std::string display_name);

  //! Get if this subject is fixed or not
  bool is_fixed();
  //! Set if this subject is fixed or not
  void set_fixed(bool fixed);

  //! Get if this subject is excluded or not
  bool is_excluded();
  //! Set if this subject is excluded or not
  void set_excluded(bool excluded);

  //! Get the explanatory variable defined for the subject, used for Linear Regression and Mixed Effects Model for optimization
  double get_explanatory_variable();
  //! Set the explanatory variable defined for the subject, used for Linear Regression and Mixed Effects Model for optimization
  void set_explanatory_variable(double val);

  //! Get the notes
  std::string get_notes();
  //! Set the notes
  void set_notes(std::string notes);

 private:
  int number_of_domains_ = 0;

  std::string display_name_;
  bool fixed_ = false;
  bool excluded_ = false;
  double explanatory_variable_ = std::numeric_limits<double>::lowest();
  StringList original_filenames_;
  StringList groomed_filenames_;
  StringList local_particle_filenames_;
  StringList world_particle_filenames_;
  StringList landmarks_filenames_;
  StringList constraints_filenames_;
  std::vector<std::vector<double>> groomed_transforms_;
  std::vector<std::vector<double>> procrustes_transforms_;

  StringMap feature_filenames_;
  StringMap group_values_;
  StringMap extra_values_;
  StringMap table_values_;
  std::string notes_;
};
}  // namespace shapeworks