Improve cuda 2d header comments

1 files changed, 7 insertions, 0 deletions

diff --git a/cuda/2d/algo.h b/cuda/2d/algo.h
index 96195a3..9f2aa00 100644
--- a/cuda/2d/algo.h
+++ b/cuda/2d/algo.h
@@ -74,6 +74,13 @@ public:
 	// instead of calling setBuffers, you can also call allocateBuffers
 	// to let ReconAlgo manage its own GPU memory
 	virtual bool allocateBuffers();
+
+	// copy data to GPU. This must be called after allocateBuffers.
+	// pfSinogram, pfReconstruction, pfVolMask, pfSinoMask are the
+	// sinogram, reconstruction, volume mask and sinogram mask in system RAM,
+	// respectively. The corresponding pitch variables give the pitches
+	// of these buffers, measured in floats.
+	// The sinogram is multiplied by fSinogramScale after uploading it.
 	virtual bool copyDataToGPU(const float* pfSinogram, unsigned int iSinogramPitch, float fSinogramScale,
 	                           const float* pfReconstruction, unsigned int iReconstructionPitch,
 	                           const float* pfVolMask, unsigned int iVolMaskPitch,