Update description data_transformer.hpp
authorSergio Guadarrama <sguada@gmail.com>
Fri, 19 Sep 2014 15:57:00 +0000 (08:57 -0700)
committerSergio <sguada@gmail.com>
Fri, 3 Oct 2014 18:45:59 +0000 (11:45 -0700)
include/caffe/data_transformer.hpp

index 25dee18..f2cbbd0 100644 (file)
@@ -27,14 +27,21 @@ class DataTransformer {
    * @brief Applies the transformation defined in the data layer's
    * transform_param block to the data.
    *
-   * @param batch_item_id
-   *    Datum position within the batch. This is used to compute the
-   *    writing position in the top blob's data
    * @param datum
    *    Datum containing the data to be transformed.
+   * @param datum_vector
+   *    A vector of Datum containing the data to be transformed.
+   * @param cv_img
+   *    cv::Mat containing the data to be transformed.
+   * @param input_blob
+   *    A Blob containing the data to be transformed.
    * @param transformed_data
-   *    This is meant to be the top blob's data. The transformed data will be
-   *    written at the appropriate place within the blob's data.
+   *    This should point to the right place in memory where the 
+   *    transformed data would be written. Assumes there is enough space
+   * @param transformed_blob
+   *    This is destionation blob. It can be part of top blob's data. 
+   *    The transformed data will be  written at the appropriate place
+   *    within the blob's data.
    */
 
   void Transform(const Datum& datum, Dtype* transformed_data);