codebase / stimlib

Commit 812a27410b94f5343f17cb2e6be4c9022cbcf85b

Authored by David Mayerich
1 parent da32c4f7

added documentation for stim::bip::project()

Showing 1 changed file with 6 additions and 0 deletions   Show diff stats
Inline Side-by-side
stim/envi/bip.h
  Show/Hide comments   View file @812a274
... ... @@ -1087,6 +1087,12 @@ public:
1087 1087 return true;
1088 1088 }
1089 1089  
  1090 + /// Project the spectra onto a set of basis functions
  1091 + /// @param outfile is the name of the new binary output file that will be created
  1092 + /// @param center is a spectrum about which the data set will be rotated (ex. when performing mean centering)
  1093 + /// @param basis a set of basis vectors that the data set will be projected onto (after centering)
  1094 + /// @param M is the number of basis vectors
  1095 + /// @param mask is a character mask used to limit processing to valid pixels
1090 1096 bool project(std::string outfile, double* center, double* basis, unsigned long long M, unsigned char* mask = NULL, bool PROGRESS = false){
1091 1097  
1092 1098 std::ofstream target(outfile.c_str(), std::ios::binary); //open the target binary file
... ...