Summer of Code - Getting Started: Difference between revisions
Carandraug (talk | contribs) m (typo missing "=") |
Carandraug (talk | contribs) (→Finish the Octave GUI: remove project since GUI is already being worked on actively and ready for release) |
||
| Line 204: | Line 204: | ||
Octave currently includes an experimental native GUI, written in Qt. There are various ways in which it could be improved. | Octave currently includes an experimental native GUI, written in Qt. There are various ways in which it could be improved. | ||
=== Implement a Qt widget for manipulating plots === | === Implement a Qt widget for manipulating plots === | ||
Revision as of 19:03, 19 February 2015
The following is distilled from the Projects page for the benefit of potential Google and ESA Summer of Code (SoC) students. Although students are welcome to attempt any of the projects in that page or any of their own choosing, here we offer some suggestions on what good student projects might be.
Steps Toward a Successful Application
If you like any of the projects described below these are the steps you need to follow to apply:
- Help Us Get To Know You
- If you aren't communicating with us before the application is due, your application will not be accepted.
- Join the maintainers mailing list or read the archives and see what topics we discuss and how the developers interact with each other.
- Hang out in our IRC channel. Ask questions, submit patches, show us that you are motivated and well-prepared. There will be more applicants than we can effectively mentor, so do ask for feedback on your public application to increase the strength of your proposal!
- Find Something That Interests You
- It's critical that you find a project that excites you. You'll be spending most of the summer working on it (we expect you to treat the SoC as a full-time job). But don't just tell us how interested you are, show us. You can do that by fixing a few bugs or interacting with us on IRC well before the deadline. Our experience shows us that successful SoC students demonstrate their interest early and often.
- Prepare Your Proposal With Us
- By working with us to prepare your proposal, you'll be getting to know us and showing us how you approach problems. The best place for this is your wiki user page and the IRC channel.
- Complete Your Application
- Fill out our public application template.
- This is best done by creating an account at this wiki and copying the template from its page.
- You really only need to copy and answer the public part there, there is no need to showcase everything else to everybody reading your user page!
- This is best done by creating an account at this wiki and copying the template from its page.
- Fill out our private application template.
- This is best done by copying the template from its page and adding the required information to your application at Google (melange) or at ESA.
- Only the organization admin and the possible mentors will see this data. You can still edit it after submitting until the deadline!
- This is best done by copying the template from its page and adding the required information to your application at Google (melange) or at ESA.
Things You'll be Expected to Know or Quickly Learn
Octave is mostly written in C++ and its own scripting language that is mostly compatible with Matlab. There are bits and pieces of Fortran, Perl, C, awk, and Unix shell scripts here and there. In addition to being familiar with C++ and Octave's scripting language, successful applicants will be familiar with or able to quickly learn about Octave's infrastructure. You can't spend the whole summer learning how to build Octave or prepare a changeset and still successfully complete your project.
- The Build System
- The GNU build system is used to build Octave.
- While you generally don't need to understand too much unless you actually want to change how Octave is built, you should be able to understand enough to get a general idea of how to build Octave.
- If you've ever done a configure && make && make install series of commands, you have already used the GNU build system.
- You must demonstrate that you are able to build the development version of Octave from sources before the application deadline.
- The Version Control System
- We use Mercurial (abbreviated hg).
- Mercurial is the distributed version control system (DVCS) we use for managing our source code. You should have some basic understanding of how a DVCS works, but hg is pretty easy to pick up, especially if you already know a VCS like git or svn.
- The Procedure for Contributing Changesets
- You will be expected to follow the same procedures as other contributors and core developers.
- You will be helping current and future Octave developers by using the same style for changes, commit messages, and so on. You should also read the same contributing guidelines we have for everyone.
- This page describes the procedures students are expected to use to publicly display their progress in a public mercurial repo during their work.
- The Maintainers Mailing List
- We primarily use mailing lists for communication among developers.
- The mailing list is used most often for discussions about non-trivial changes to Octave, or for setting the direction of development.
- You should follow basic mailing list etiquette. For us, this mostly means "do not top post".
- The IRC Channel
- We also have the #octave IRC channel in Freenode.
- You should be familiar with the IRC channel. It's very helpful for new contributors (you) to get immediate feedback on ideas and code.
- Unless your primary mentor has a strong preference for some other method of communication, the IRC channel will likely be your primary means of communicating with your mentor and Octave developers.
- The Octave Forge Project
- Octave-Forge is a project closely related to Octave where packages reside. They are somewhat analogous to Matlab's toolboxes.
- Related Skills
- In addition, you probably should know some mathematics, engineering, or experimental science or something of the sort.
- If you've used Matlab before, you probably have already been exposed to the kinds of problems that Octave is used for.
Criteria by which applications are judged
These might vary somewhat depending on the mentors and coordinators for a particular Summer of Code, but typically the main factors considered would be:
- Applicant has demonstrated an ability to make substantial modifications to Octave
- The most important thing is that your application has some interesting code samples to judge you by. It's ok during the application period to ask for help on how to format these code samples, which normally are Mercurial patches.
- Applicant shows understanding of topic
- Your application should make it clear that you're reasonably well versed in the subject area and won't need all summer just to read up on it.
- Applicant shows understanding of and interest in Octave development
- The best evidence for this is previous contributions and interactions.
- Well thought out, adequately detailed, realistic project plan
- "I'm good at this, so trust me" isn't enough. You should describe which algorithms you'll use and how you'll integrate with existing Octave code. You should also prepare a full timeline and goals for the midterm and final evaluations.
Suggested projects
The following projects are broadly grouped by category and probable skills required to tackle each. Remember to check Projects for more ideas if none of these suit you, and your own ideas are always welcome.
Numerical
These projects involve implementing certain mathematical functions in Octave.
General purpose Finite Element library
Octave-Forge already has a set of packages for discretizing Partial Differential operators by Finite Elements and/or Finite Volumes, namely the bim package which relies on the msh package (which is in turn based on gmsh) for creating and managing 2D triangular and 3D tetrahedral meshes and on the fpl package for visualizing 2D results within Octave or exporting 2D or 3D results in a format compatible with Paraview or VisIT. These packages, though, offer only a limited choice of spatial discretization methods which are based on low degree polynomials and therefore have a low order of accuracy even for problems with extremely smooth solutions. The GeoPDEs project, on the other hand, offers a complete suite of functions for discretizing a wide range of differential operators related to important physical problems and uses basis functions of arbitrary polynomial degree that allow the construction of methods of high accuracy. These latter, though, are based on the IsoGeometric Analysis Method which, although very powerful and often better performing, is less widely known and adopted than the Finite Elements Method. The implementation of a general purpose library of Finite Elements seems therefore a valuable addition to Octave-Forge. Two possible interesting choices for implementing this package exist, the first consists of implementing the most common Finite Element spaces in the GeoPDEs framework, which is possible as IsoGeometric Analysis can be viewed as a superset of the Finite Element Method, the other is to construct Octave language bindings for the free software library FEniCS based on the existing C++ or Python interfaces. This second approach has been developed during the GSOC 2013 and the Octave-Forge package fem-fenics is now available. However, fem-fenics could be extended in many different ways:
- implement the bindings for the UFL language inside Octave
- add new functions already available with Fenics but not yet in Octave
- create new functions specifically suited for Octave
- improve the efficiency of the code
The main goal for the fem-fenics package is ultimately to be merged with the FEnics project itself, so that it can remain in-sync with the main library development.
Potential mentor: Marco Vassallo
Improve logm, sqrtm, funm
The goal here is to implement some missing Matlab functions related to matrix functions like the matrix exponential. There is a general discussion of the problem.
Potential mentor: Jordi Gutiérrez Hermoso
Generalised eigenvalue problem
Certain calling forms of the eig function are currently missing, including preliminary balancing; computing left eigenvectors as a third output; and choosing among generalized eigenvalue algorithms. See also this discussion.
Required skills: C++; familiarity with numerical linear algebra and LAPACK.
Difficulty: medium.
Potential mentor: Nir Krakauer
Various sparse matrix improvements
The implementation of sparse matrices in Octave needs several improvements. Any of these would be good. The paper by Bateman & Adler is good reading for understanding the sparse matrix implementation.
Implement solver for initial-boundary value problems for parabolic-elliptic PDEs in 1D
The project will deliver a solver for initial-boundary value problems for parabolic-elliptic PDEs in 1D similar to Matlab's function pdepe. A good starting point is the method of lines for which you can find more details here and here, whereas an example implementation can be found here. In addition, this page provides some useful material.
Implement solver for 1D nonlinear boundary value problems
The project will complete the implementation of the bvp4c solver that is already available in an initial version in the odepkg package by adding a proper error estimator and will implement a matlab-compatible version of the bvp5c solver. Details on the methods to be implemented can be found in this paper on bvp4c and this paper on bvp5c. Further details are available in this book.
Geometric integrators for Hamiltonian Systems
Geometric (AKA Symplectic) integrators are useful for multi-dimensional classical mechanics problems and for molecular dynamics simulations. The odepkg package has a number of solvers for ODE, DAE and DDE problems but none of them is currently specifically suited for second order problems in general and Hamiltonian systems in particular. Therefore a new package for geometric integrators would be a useful contribution. This could be created as new package or added as a set of new functions for odepkg. The function interface should be consistent throughout the package and should be modeled to follow that of other functions in odepkg (or that of DASPK and LSODE) but will need specific extensions to accommodate for specific options that only make sense for this specific class of solvers. An initial list of methods to be implemented includes (but is not limited to)
- Symplectic Euler methods, see here and here
- Störmer-Verlet method, see here and here
- Velocity Verlet method, see here and here
- Symplectic partitioned Runge-Kutta methods, see here or here
- Spectral Variational Integrator methods, see here or here
For this latter there is an existing code which is already working but needs to be improved, posted on the patch tracker. Furthermore, methods to implement solutions of problems with rigid constraints should be implemented, e.g.
Potential mentor: Mattia Penati, Edie Miglio, Carlo de Falco
Matlab-compatible ODE solvers in core-Octave
- Adapt "odeset" and "odeget" from the odepkg package so that the list of supported options is more Matlab-compatible, in the sense that all option names that are supported by Matlab should be available. On the other hand, Matlab returns an error if an option which is not in the list of known options is passed to "odeset", but we would rather make this a warning in order to allow for special extensions, for example for symplectic integrators.
- Adapt the interface of "ode45" in odepkg to be completely Matlab compatible, fix its code and documentation style and move it to Octave-core.
- Build Matlab compatible versions of "ode15s" and "ode15i". jwe has prototype implementations [1] of these built as wrappers to "dassl" and "daspk". An initial approach could be to just improve these wrappers, but eventually it would be better to have wrappers for "IDA" from the sundials library.
- Implement Matlab compatible versions of "deval".
Potential mentor: Sebastian Schöps, Carlo de Falco, JuanPi Carbajal
Nonlinear and constrained least squares
The Optimization package is missing the functions lsqcurvefit, lsqlin, lsqnonlin to conveniently solve least-squares problems that are nonlinear and/or constrained. There are free implementations of the needed algorithms in other languages, such as minpack in Fortran and levmar in C. This project would link to or port these implementations and develop Matlab-compatible Octave wrappers.
Mentor: Nir Krakauer
TISEAN package
TISEAN is a suite of code for nonlinear time series analysis. It is old but there are many algorithms there that haven't been re-implemented as libre software. The objective is to integrate TISEAN as a octave package as it was done for the Control package. The functions cuould be integrated in the existing time series analysis package
Required skills: m-file scripting, c/C++ and FORTRAN API knowledge.
Difficulty: easy/medium
Mentor: User:KaKiLa
High Precision Arithmetic Computation
The Linear Algebra Fortran libraries used by Octave make use of of single (32 bits) and double (64 bits) precision floating point numbers. Many operations are stopped when matrices condition number goes below 1e-16: such matrices are considered as ill-conditioned. There are cases where this is not enough, for instance simulations implying chemical concentrations covering the range 10^4 up to 10^34. There are a number of ways to increase the numerical resolution, like f.i. make use of 128 bits quadruple precision numbers available in GFortran. A simpler option is to build an interface over Gnu MPL arbitrary precision library, which is used internally by gcc and should be available on any platform where gcc runs. Such approach has been made available for MatLab under the name mptoolbox and is licensed under a BSD license. The author kindly provided a copy of the latest version and agreed to have it ported under Octave and re-distributed under GPL v3.0
The architecture consists of an Octave class interface implementing "mp" (multi-precision) objects. Arithmetic operations are forwarded to MPL using MEX files. This is totally transparent to the end user, except when displaying numbers. This implementation needs to be ported and tested under Octave.
Required skills: Octave classes and object programming. C for understanding the MEX glue code.
Difficulty: medium.
Potential mentor: Pascal Dupuis
GUI
Octave currently includes an experimental native GUI, written in Qt. There are various ways in which it could be improved.
Implement a Qt widget for manipulating plots
Octave has had for some time a native OpenGL plotter. The plotter requires some user interaction for manipulating the plots, and it's been using fltk for quite some time. We want to replace this with Qt, so it fits better with the overall GUI look-and-feel and is easier to extend in the future.
QtHandles is a current work in progress integrating the octave OpenGL renderer plus good support for GUI elements (uicontrol, uimenu, uitoolbar...). This project may initially consists of integrating the existing QtHandles code base into Octave. Then if time permits, further improvements can be made to QtHandles.
Create a better (G)UI for the profiler
During GSoC 2011, Daniel Kraft successfully implemented a profiler for Octave. It needs a better interface and a way to generate reports. This may be done with Qt, but not necessarily, and HTML reports might also be good.
Sisotool. Create a graphical design tool for tuning closed loop control system (control pkg)
When tuning a SISO feedback system it is very helpful to be able to grab a pole or a zero and move them by dragging them with the mouse. As they are moving the software must update all the plotted lines. There should be the ability to display various graphs rlocuse, bode, step, impulse etc. and have them all change dynamically as the mouse is moving. The parameters of the compensator must be displayed and updated. Potential mentor: Doug Stewart
Interface to Electronic Circuit Simulator
Qucs is a C++ based circuit simulation package. This project aims to improve the interface to the Qucs algorithms to allow the transient, i.e. time series, simulation of circuits in Octave within a larger ODE system simulation driven by Octave. Other possible goals would be to make other analysis types available directly from Octave. There is an existing C++ interface which is based on handle class syntax available in the development version of Octave. The Qucs interface is intended to have two modes, synchronous and asynchronous. The asynchronous mode uses qucs to solve a circuit between two given time steps (internally taking as many smaller time steps as required), returning only the final result. This method is well developed. The alternative synchronous mode is intended to give full control of the time steps to Octave, and it is this mode which requires more work. A simple synchronous interface exists which can be built upon.
Required skills: C++ and m-file scripting. Familiarity with new classdef syntax would be useful. May require some modification/adaptation of the Qucs sources. Familiarity with the Octave ODE solvers useful but not essential. Ability to compile Octave from the development sources.
Difficulty: medium.
Potential mentor: Richard Crozier Unfortunately I can't mentor this year (2014)
Main Goals
- Improve the functionality of the transient solver interface by implementing a robust synchronous simulation mode that integrates well with Octave ode solvers, particularly those from the odepkg package from OctaveForge.
- Create interface to other analysis types (AC, DC, S-Parameter and Harmonic Balance)
- Packaging the interface for Octave, to make it available through OctaveForge
Graphics
Octave has a new native OpenGL plotter (currently via fltk, but we want to move away from that). There are several possible projects involved with it.
Lighting
Implement transparency and lighting in OpenGL backend(s). A basic implementation is available in JHandles. This needs to be ported/re-implement/re-engineered/optimized in the C++ OpenGL renderer of Octave.
Object selection in OpenGL renderer
This project is about the implementation of a selection method of graphics elements within the OpenGL renderer [2]
Non-OpenGL renderer
Besides the original gnuplot backend, Octave also contains an OpenGL-based renderer for advanced and more powerful 3D plots. However, OpenGL is not perfectly suited for 2D-only plots where other methods could result in better graphics. The purpose of this project is to implement an alternate graphics renderer for 2D only plots (although 3D is definitely not the focus, extending the new graphics renderer to support basic 3D features should also be taken into account). There is no particular toolkit/library that must be used, but natural candidates are:
- Qt: the GUI is currently written in Qt and work is also in progress to provide a Qt/OpenGL based backend [3]
- Cairo: this library is widely used and known to provides high-quality graphics with support for PS/PDF/SVG output.
TeX/LaTeX markup
Text objects in plots (like titles, labels, texts...) in the OpenGL renderer only support plain text mode without any formatting possibility. Support for TeX and/or LaTeX formatting needs to be added.
- The TeX formatting support actually only consists of a very limited subset of the TeX language. This can be implemented directly in C++ into Octave by extending the existing text engine, avoiding to add a dependency on a full TeX system. Essentially, support for Greek letters, super/sub-scripts, and several mathematical symbols needs to be supported. For example,
\alpha \approx \beta_0 + \gamma^\chi
- Would be rendered as,
- α ≈ β0 + γχ
- This is analogous to how special characters may be included in a wiki using html.
α ≈ β<sub>0</sub> + γ<sup>χ</sup>
- The text object's
extentfor the rendered result needs to be calculated and the text placed the location specified by the text object'spositionproperty. An itemized list of a text objects properties can be found here.
- On the other hand, the LaTeX formatting support is expected to provide full LaTeX capabilities. This will require to use an external LaTeX system to produce text graphics in some format (to be specified) that is then integrated into Octave plots.
- The matplotlib project has already done this in Python and might be used as an example of how to do this in Octave. Mediawiki has also also done something similar. There is also JLaTeXMath, a Java API to display LaTeX code in mathematical mode.
Interpreter
The interpreter is written in C++, undocumented. There are many possible projects associated with it.
Required skills: Very good C and C++ knowledge, possibly also understanding of GNU bison and flex. Understanding how compilers and interpreters are made plus being able to understand how to use a profiler and a debugger will probably be essential skills.
Difficulty: Mid hard to very hard. Some of the biggest problems will probably be the interpreter.
Improve JIT compiling
Octave's interpreter is very slow on some loops. Recently, thanks to Max Brister's work, an initial implement of a just-in-time compiler (JITC) in LLVM for GSoC 2012. This project consists in understanding Max's current implementation and extending it so that functions and exponents (e.g. 2^z) compile with the JITC. This requires knowledge of compilers, C++, LLVM, and the Octave or Matlab languages. A capable student who demonstrates the ability to acquire this knowledge quickly may also be considered. Max himself will mentor this project. Here is Max's OctConf 2012 presentation about his current implementation. See also JIT.
Improve memory management
From profiling the interpreter, it appears that a lot of time is spending allocating and deallocating memory. A better memory management algorithm might provide some improvement.
Implement classdef classes
Matlab has two kinds of classes: old style @classes and new style classdef. Octave has only fully implemented the old style. There is partial support for new classes in our classdef branch. There is irregular work here, and classdef is a very complicated thing to fully implement. A successful project would be to implement enough of classdef for most basic usages. Familiarity with Matlab's current classdef support would be a huge plus. Michael Goffioul and jwe can mentor this.
Although there's already a substantial classdef support in current octave code base, there are still many areas that are unimplemented or need improvements. The main ones that come to my mind are:
- support for events
- support for enums
- support for "import" (this requires good understanding of octave internals, especially he symbol table)
- improving multiple inheritance and method resolution
- honoring and computing "Sealed" attribute
- support for function handle to methods
Improve MPI package
Octave Forge's MPI package is a wrapper for basic MPI functions for parallel computing. It is implemented by wrapping MPI function calls in simple DLD functions that map Octave's Datataypes to MPI Derived Datatypes. The proposed project deals with improving and extending the Octave MPI package, for example:
- Octave MPI applications can currently be only run in batch mode, add the ability to launch parallel jobs and collect their output in an interactive Octave session.
- Implement functions for non-blocking communication (MPI_Isend, MPI_Irecv)
- Implement one-to-many (Broadcast, Scatter), many-to-one (Reduce, Gather), and many-to-many (All Reduce, Allgather) communication routines
Required skills: C++. Message Passing Interface (MPI).
Difficulty: medium.
Potential mentor: Carlo de Falco, Michael Creel, Sukanta Basu
Infrastructure
There are several projects closely related to Octave but not exactly core Octave that could be worked on. They are mostly infrastructure around Octave, stuff that would help a lot.
Finish the Agora website
In 2009, the Mathworks decided to restrict the terms of use Matlab Central, a place dedicated to Matlab collaboration. The Mathworks forbade copyleft licenses and using the "free" code found in Matlab central on anything other than Mathworks products (e.g. forbidding from using it on Octave, even if the authors of the code wanted to allow this). Thus Octave users have no place to centrally, quickly, and conveniently share Octave code. See the FAQ for more details.
In response to this, a website started to form, Agora Octave.
This should be relatively easy webdev in Python using Django.
Things to be considered when working on this:
- discussion of Agora during OctConf2012
- Scipy Central - a website with the same objective as Agora for Scipy. Their Code is released under a BSD license. Might be useful to reuse some parts.
Most of the basic functionality of Agora is already in, but there are many ways in which it could be improved, such as implementing comment threads, giving it an email interface, or a ReSTful API which could be used from Octave for package management. See also Agora.
Improve binary packaging
We would like to be able to easily generate binary packages for Windows and Mac OS X. Right now, it's difficult and tedious to do so. Any way to help us do this in a faster way would be appreciated. Required knowledge is understanding how building binaries in Windows and Mac OS X works. Our current approach to fixing this is to cross-compile from a GNU system using MXE or GUB.
Skills Required: Knowledge of GNU build systems, Makefiles, configure files, chasing library dependencies, how to use a compiler. If you choose to work on GUB, Python will be required. No m-scripting or C++ necessary, beyond understanding the C++ compilation model.
Difficulty: Medium to easy. You need to understand how build systems work and how to fix packages when they don't build.
Possible mentors: John W. Eaton or Jordi Gutiérrez Hermoso
Octave Package management
Octave management of installed packages is performed by a single function, pkg, which does pretty much everything. This function has a few limitations which are hard to implement with the current codebase, and will most likely require a full rewrite.
The planned improvements are:
- support for multiple Octave installs
- support for multiple version packages
- support for system-wide and user installed packages
- automatic handling of dependencies
- more flexibility on dependencies, e.g., dependent on specific Octave build options or being dependent in one of multiple packages
- management of tests and demos in C++ sources of packages
- think ahead for multiple
- easily load or check specific package versions
The current pkg also performs some functions which probably should not. Instead a package for developers should be created with such tools.
Many of these problems have been solved in other languages. Familiarity with how other languages handle this problem will be useful to come up with elegant solutions. In some cases, there are standards to follow. For example, there are specifications published by freedesktop.org about where files should go (base directory spec) and Windows seems to have its own standards. See bugs #36477 and #40444 for more details.
In addition, package names may start to collide very easily. One horrible way to workaround this by is choosing increasingly complex package names that give no hint on the package purpose. A much better is option is providing an Authority category like Perl 6 does. Nested packages is also an easy way to provide packages for specialized subjects (think image::morphology). A new pkg would think all this things now, or allow their implementation at a later time. Read the unfinished plan for more details.
Minimum requirements: Ability to read and write Octave code, experience with Octave packages, and understanding of the basics of autotools. The most important skill is software design.
Difficulty: Easy to Medium
Mentor: Carnë Draug
Image Analysis
Improvements to N-dimensional image processing
The image package has partial functionality for N-dimensional images. These images exist for example in medical imaging where slices from scans are assembled to form anatomical 3D images. If taken over time and at different laser wavelengths or light filters, they can also result in 5D images. Albeit less common, images with even more dimensions also exist. However, their existence is irrelevant since most of the image processing operations are mathematical operations which are independent of the number of dimensions.
As part of GSoC 2013, the core functions for image IO, imwrite and imread, were extended to better support this type of images. Likewise, many functions in the image package, mostly morphology operators, were expanded to deal with this type of image. Since then, many other functions have been improved, sometimes completely rewritten, to abstract from the number of dimensions. In a certain way, supporting ND images is also related to choosing good algorithms since such large images tend to be quite large.
This project will continue on the previous work, and be mentored by the previous GSoC student and current image package maintainer. Planning the project requires selection of functions lacking ND support and identifying their dependencies. For example, supporting imclose and imopen was better implemented by supporting imerode and imdilate which then propagated ND support to all of its dependencies. These dependencies need to be discovered first since often they are not being used yet, and may even be missing function. This project can also be about implementing functions that have not yet been implemented. Also note that while some functions in the image package will accept ND images as input, they are actually not correctly implemented and will give incorrect results.
Required skills: m-file scripting, and a fair amount of C++ since a lot of image analysis cannot be vectorized. Familiarity with common CS algorithms and willingness to read literature describing new algorithms will be useful.
Difficulty: difficult
Potential mentor: Carnë Draug
Improve Octave's image IO
There are a lot of image formats. To handle this, Octave uses GraphicsMagic (GM), a library capable of handling a lot of them in a single C++ interface. However, GraphicsMagick still has its limitations. The most important are:
- GM has build option
quantumwhich defines the bitdepth to use when reading an image. Building GM with high quantum means that images of smaller bitdepth will take a lot more memory when reading, but building it too low will make it impossible to read images of higher bitdepth. It also means that the image needs to always be rescaled to the correct range. - GM supports unsigned integers only thus incorrectly reading files such as TIFF with floating point data
- GM hides away details of the image such as whether the image file is indexed. This makes it hard to access the real data stored on file.
This project would implement better image IO for scientific file formats while leaving GM handle the others. Since TIFF is the de facto standard for scientific images, this should be done first. Among the targets for the project are:
- implement the Tiff class which is a wrap around libtiff, using classdef. To avoid creating too many private __oct functions, this project could also create a C++ interface to declare new Octave classdef functions.
- improve imread, imwrite, and imfinfo for tiff files using the newly created Tiff class
- port the bioformats into Octave and prepare a package for it
- investigate other image IO libraries
- clean up and finish the dicom package to include into Octave core
- prepare a matlab compatible implementation of the FITS package for inclusion in Octave core
Required skills: knowledge of C++ and C since most libraries are written in those languages
Difficulty: medium
Potential mentor: Carnë Draug