From 1938d006595f82aaa745cb0573b86babd35def4b Mon Sep 17 00:00:00 2001
From: Wenzel Jakob <wenzel@cs.cornell.edu>
Date: Tue, 10 Dec 2013 00:09:37 +0100
Subject: [PATCH] libpython: bindings for the Sensor class

---
 include/mitsuba/render/sensor.h | 20 ++++++++++---
 src/libpython/render.cpp        | 53 +++++++++++++++++++++++++++++++--
 2 files changed, 67 insertions(+), 6 deletions(-)

diff --git a/include/mitsuba/render/sensor.h b/include/mitsuba/render/sensor.h
index 6dc232c3..671a2d66 100644
--- a/include/mitsuba/render/sensor.h
+++ b/include/mitsuba/render/sensor.h
@@ -135,11 +135,11 @@ public:
 	 *    An importance weight associated with the sampled ray.
 	 *    This accounts for the difference between the sensor response
 	 *    and the sampling density function.
+	 *
+	 * \remark
+	 *    In the Python API, the signature of this function is
+	 *    <tt>spectrum, ray = sensor.sampleRay(samplePosition, apertureSample)</tt>
 	 */
-	virtual Spectrum sampleRay(Ray &ray,
-		const Point2 &samplePosition,
-		const Point2 &apertureSample,
-		Float timeSample) const = 0;
 
 	/**
 	 * \brief Importance sample a ray differential according to the
@@ -183,6 +183,10 @@ public:
 	 *    An importance weight associated with the sampled ray.
 	 *    This accounts for the difference between the sensor response
 	 *    and the sampling density function.
+	 *
+	 * \remark
+	 *    In the Python API, the signature of this function is
+	 *    <tt>spectrum, ray = sensor.sampleRayDifferential(samplePosition, apertureSample)</tt>
 	 */
 	virtual Spectrum sampleRayDifferential(RayDifferential &ray,
 		const Point2 &samplePosition,
@@ -230,6 +234,10 @@ public:
 	 *
 	 * \return
 	 *    The emitted importance
+	 *
+	 * \remark
+	 *    In the Python API, the signature of this function is
+	 *    <tt>spectrum, samplePos = sensor.eval(its, d)</tt>
 	 */
 	virtual Spectrum eval(const Intersection &its, const Vector &d,
 			Point2 &samplePos) const;
@@ -245,6 +253,10 @@ public:
 	 *    A position sampling record, which specifies the query position
 	 *
 	 * \return \c true if the specified ray is visible by the camera
+	 *
+	 * \remark
+	 *    In the Python API, the signature of this function is
+	 *    <tt>visible, position = sensor.getSamplePosition(pRec, dRec)</tt>
 	 */
 	virtual bool getSamplePosition(const PositionSamplingRecord &pRec,
 			const DirectionSamplingRecord &dRec, Point2 &position) const;
diff --git a/src/libpython/render.cpp b/src/libpython/render.cpp
index 5d69c3b0..797fdfb9 100644
--- a/src/libpython/render.cpp
+++ b/src/libpython/render.cpp
@@ -236,6 +236,29 @@ static void renderJob_cancel(RenderJob *job) {
 	job->cancel();
 }
 
+bp::tuple Sensor_sampleRay(Sensor *sensor, const Point2 &samplePosition, const Point2 &apertureSample, Float timeSample) {
+	Ray ray;
+	Spectrum result = sensor->sampleRay(ray, samplePosition, apertureSample, timeSample);
+	return bp::make_tuple(result, ray);
+}
+
+bp::tuple Sensor_sampleRayDifferential(Sensor *sensor, const Point2 &samplePosition, const Point2 &apertureSample, Float timeSample) {
+	RayDifferential ray;
+	Spectrum result = sensor->sampleRay(ray, samplePosition, apertureSample, timeSample);
+	return bp::make_tuple(result, ray);
+}
+
+bp::tuple Sensor_eval(Sensor *sensor, const Intersection &its, const Vector &d) {
+	Point2 samplePos;
+	Spectrum result = sensor->eval(its, d, samplePos);
+	return bp::make_tuple(result, samplePos);
+}
+
+bp::tuple Sensor_getSamplePosition(Sensor *sensor, const PositionSamplingRecord &pRec, const DirectionSamplingRecord &dRec) {
+	Point2 samplePos;
+	bool result = sensor->getSamplePosition(pRec, dRec, samplePos);
+	return bp::make_tuple(result, samplePos);
+}
 
 void export_render() {
 	bp::object renderModule(
@@ -524,11 +547,37 @@ void export_render() {
 		.export_values();
 	BP_SETSCOPE(renderModule);
 
-	BP_CLASS(Sensor, AbstractEmitter, bp::no_init) // incomplete
+	Film *(Sensor::*sensor_getFilm)(void) = &Sensor::getFilm;
+	Sampler *(Sensor::*sensor_getSampler)(void) = &Sensor::getSampler;
+
+	BP_CLASS(Sensor, AbstractEmitter, bp::no_init)
 		.def("getShutterOpen", &Sensor::getShutterOpen)
 		.def("setShutterOpen", &Sensor::setShutterOpen)
 		.def("getShutterOpenTime", &Sensor::getShutterOpenTime)
-		.def("setShutterOpenTime", &Sensor::setShutterOpenTime);
+		.def("setShutterOpenTime", &Sensor::setShutterOpenTime)
+		.def("sampleTime", &Sensor::sampleTime)
+		.def("sampleRay", &Sensor_sampleRay)
+		.def("sampleRayDifferential", &Sensor_sampleRayDifferential)
+		.def("eval", &Sensor_eval, BP_RETURN_VALUE)
+		.def("getSamplePosition", &Sensor_getSamplePosition)
+		.def("pdfTime", &Sensor::pdfTime)
+		.def("needsTimeSample", &Sensor::needsTimeSample)
+		.def("needsApertureSample", &Sensor::needsApertureSample)
+		.def("getFilm", sensor_getFilm, BP_RETURN_VALUE)
+		.def("getSampler", sensor_getSampler, BP_RETURN_VALUE)
+		.def("getAspect", &Sensor::getAspect);
+
+	BP_SETSCOPE(Sensor_class);
+	bp::enum_<Sensor::ESensorFlags>("ESensorFlags")
+		.value("EDeltaTime", Sensor::EDeltaTime)
+		.value("ENeedsApertureSample", Sensor::ENeedsApertureSample)
+		.value("EProjectiveCamera", Sensor::EProjectiveCamera)
+		.value("EPerspectiveCamera", Sensor::EPerspectiveCamera)
+		.value("EOrthographicCamera", Sensor::EOrthographicCamera)
+		.value("EPositionSampleMapsToPixels", Sensor::EPositionSampleMapsToPixels)
+		.value("EDirectionSampleMapsToPixels", Sensor::EDirectionSampleMapsToPixels)
+		.export_values();
+	BP_SETSCOPE(renderModule);
 
 	void (Film::*film_develop1)(const Scene *scene, Float renderTime) = &Film::develop;
 	bool (Film::*film_develop2)(const Point2i &offset, const Vector2i &size,