Updated documentation for ApolloMetricCamera and ApolloMetricCameraDistortionMap. References #4807. (e2af08d0) · Commits · aflab / astrogeology / ISIS3

isis/src/apollo/objs/ApolloMetricCamera/ApolloMetricCamera.cpp

+1 −1

Original line number	Diff line number	Diff line
		@@ -161,7 +161,7 @@ namespace Isis {
		* This is the function that is called in order to instantiate an
		* ApolloMetricCamera object.
		*
		* @param lab Cube labels
		* @param cube Cube
		*
		* @return Camera* ApolloMetricCamera
		* @internal

isis/src/apollo/objs/ApolloMetricCamera/ApolloMetricCamera.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -58,6 +58,7 @@ namespace Isis {
		* @history 2015-10-16 Ian Humphrey - Removed declarations of spacecraft and instrument
		* members and methods and removed implementation of these methods
		* since Camera now handles this. References #2335.
		* @history 2017-06-28 Makayla Shepherd - Updated documentation. References #4807.
		*/
		class ApolloMetricCamera : public FramingCamera {
		public:

isis/src/apollo/objs/ApolloMetricCamera/ApolloMetricDistortionMap.h

+50 −0

Original line number	Diff line number	Diff line
		@@ -32,16 +32,66 @@ namespace Isis {
		* Apollo namespace wrap inside Isis namespace. Added
		* Isis Disclaimer to files.
		* @history 2013-03-18 Debbie A. Cook - Added flag to flip focal plane z axis
		* @history 2017-06-28 Makayla Shepherd - Updated documentation. References #4807.
		*/
		class ApolloMetricDistortionMap : public CameraDistortionMap {
		public:
		/**
		*
		* Constructs a Distortion Map object for the Apollo Metric Camera.
		*
		* @param parent Pointer to parent Camera object
		* @param xp Pricipal point x-coordinate
		* @param yp Pricipal point y-coordinate
		* @param k1 First coefficient of radial distortion
		* @param k2 Second coefficient of radial distortion
		* @param k3 Third coefficient of radial distortion
		* @param j1 First coefficient of decentering distortion
		* @param j2 Second coefficient of decentering distortion
		* @param t0 Angle between positive x-axis of image and vector to imaged point
		*
		* @internal
		* @history 2011-05-03 Jeannie Walldren - Added documentation.
		* @history 2013-03-18 Debbie A. Cook - Added flag to flip focal plane z axis
		*/
		ApolloMetricDistortionMap(Camera *parent, double xp, double yp,
		double k1, double k2, double k3, double j1,
		double j2, double t0);


		//! Destroys ApolloMetricDistortionMap object.
		~ApolloMetricDistortionMap() {};


		/**
		* Compute undistorted focal plane x/y
		*
		* Compute undistorted focal plane x/y given a distorted focal plane x/y.
		* fter calling this method, you can obtain the undistorted
		* x/y via the UndistortedFocalPlaneX and UndistortedFocalPlaneY methods
		*
		* @param dx Distorted focal plane x, in millimeters
		* @param dy Distorted focal plane y, in millimeters
		*
		* @return whether the conversion was successful
		*/
		bool SetFocalPlane(const double dx, const double dy);


		/**
		* Compute distorted focal plane x/y
		*
		* Compute distorted focal plane x/y given an undistorted focal plane x/y.
		* After calling this method, you can obtain the distorted x/y via the
		* FocalPlaneX and FocalPlaneY methods
		*
		* @param ux Undistorted focal plane x, in millimeters
		* @param uy Undistorted focal plane y, in millimeters
		*
		* @return whether the conversion was successful
		*/
		bool SetUndistortedFocalPlane(const double ux, const double uy);

		private:
		// parameters below are from camera calibration report
		double p_xp; //!< Principal point x-coordinate.