Commit baa4a213279fef5685cb39f8185ed703cad98041
1 parent
e1f199dc
Comment updates
Showing
2 changed files
with
11 additions
and
10 deletions
openbr/plugins/classification/lda.cpp
| @@ -52,8 +52,8 @@ BR_REGISTER(Initializer, EigenInitializer) | @@ -52,8 +52,8 @@ BR_REGISTER(Initializer, EigenInitializer) | ||
| 52 | * \author Josh Klontz \cite jklontz | 52 | * \author Josh Klontz \cite jklontz |
| 53 | * | 53 | * |
| 54 | * \br_property float keep Options are: [keep < 0 - All eigenvalues are retained, keep == 0 - No PCA is performed and the eigenvectors form an identity matrix, 0 < keep < 1 - Keep is the fraction of the variance to retain, keep >= 1 - keep is the number of leading eigenvectors to retain] Default is 0.95. | 54 | * \br_property float keep Options are: [keep < 0 - All eigenvalues are retained, keep == 0 - No PCA is performed and the eigenvectors form an identity matrix, 0 < keep < 1 - Keep is the fraction of the variance to retain, keep >= 1 - keep is the number of leading eigenvectors to retain] Default is 0.95. |
| 55 | - * \br_property int drop BRENDAN OR JOSH FILL ME IN. Default is 0. | ||
| 56 | - * \br_property bool whiten BRENDAN OR JOSH FILL ME IN. Default is false. | 55 | + * \br_property int drop The number of leading eigen-dimensions to drop. |
| 56 | + * \br_property bool whiten Whether or not to perform PCA whitening (i.e., normalize variance of each dimension to unit norm) | ||
| 57 | */ | 57 | */ |
| 58 | class PCATransform : public Transform | 58 | class PCATransform : public Transform |
| 59 | { | 59 | { |
| @@ -275,13 +275,13 @@ BR_REGISTER(Transform, DFFSTransform) | @@ -275,13 +275,13 @@ BR_REGISTER(Transform, DFFSTransform) | ||
| 275 | * \brief Projects input into learned Linear Discriminant Analysis subspace. | 275 | * \brief Projects input into learned Linear Discriminant Analysis subspace. |
| 276 | * \author Brendan Klare \cite bklare | 276 | * \author Brendan Klare \cite bklare |
| 277 | * \author Josh Klontz \cite jklontz | 277 | * \author Josh Klontz \cite jklontz |
| 278 | - * \br_property float pcaKeep BRENDAN OR JOSH FILL ME IN. Default is 0.98. | ||
| 279 | - * \br_property bool pcaWhiten BRENDAN OR JOSH FILL ME IN. Default is false. | ||
| 280 | - * \br_property int directLDA BRENDAN OR JOSH FILL ME IN. Default is 0. | ||
| 281 | - * \br_property float directDrop BRENDAN OR JOSH FILL ME IN. Default is 0.1. | ||
| 282 | - * \br_property QString inputVariable BRENDAN OR JOSH FILL ME IN. Default is "Label". | ||
| 283 | - * \br_property bool isBinary BRENDAN OR JOSH FILL ME IN. Default is false. | ||
| 284 | - * \br_property bool normalize BRENDAN OR JOSH FILL ME IN. Default is true. | 278 | + * \br_property float pcaKeep If <= 1, the percentage of variance to retain in initial PCA step. If > 1, the number of dimensions to keep. |
| 279 | + * \br_property bool pcaWhiten Whether or not to perform whitening during PCA step | ||
| 280 | + * \br_property int directLDA Whether or not to use the Direct LDA algorithm. | ||
| 281 | + * \br_property float directDrop Parameter for Direct LDA to specify how many leading vectors in within class matrix to drop. Based on variance. | ||
| 282 | + * \br_property QString inputVariable Metadata key for subject labels. | ||
| 283 | + * \br_property bool isBinary Whether or not to perform binary LDA. Default is multi-class LDA (i.e., distance metric learning). | ||
| 284 | + * \br_property bool normalize For binary LDA, whether or not to z-score normalize projection. | ||
| 285 | */ | 285 | */ |
| 286 | class LDATransform : public Transform | 286 | class LDATransform : public Transform |
| 287 | { | 287 | { |
openbr/plugins/imgproc/split.cpp
| @@ -45,7 +45,8 @@ BR_REGISTER(Transform, SplitChannelsTransform) | @@ -45,7 +45,8 @@ BR_REGISTER(Transform, SplitChannelsTransform) | ||
| 45 | 45 | ||
| 46 | /*! | 46 | /*! |
| 47 | * \ingroup transforms | 47 | * \ingroup transforms |
| 48 | - * \brief Split a multi-row matrix into several single-row matrices. | 48 | + * \brief Split a multi-row matrix into several single-row or smaller multi-row matrices. |
| 49 | + * \br_property int step The numbers of rows to include in each output matrix. | ||
| 49 | * \author Josh Klontz \cite jklontz | 50 | * \author Josh Klontz \cite jklontz |
| 50 | */ | 51 | */ |
| 51 | class SplitRowsTransform : public UntrainableTransform | 52 | class SplitRowsTransform : public UntrainableTransform |