Caret7:Development/DevelopmentStrategy

From Van Essen Lab

(Difference between revisions)
Jump to: navigation, search
(Coding (For October, 2011))
Line 35: Line 35:
# Examine [http://cpptest.sourceforge.net/ CppTest] for unit testing.
# Examine [http://cpptest.sourceforge.net/ CppTest] for unit testing.
# Minimize usage of third party libraries and their components.  When possible, encapsulate code from the third party so that users of the class never see the third party library.  For example, the base class for XML parsing is abstract.  A concrete class for XML parsing is implemented using QT's XML parsing library.  Users call a factory method in abstract XML parser class that returns a parsers.  Delegates that receive the SAX XML tags and characters have no knowledge about the actual implementation of the XML parser.  If fact, the QT  XML parser could be replaced with a different XML parser and the delegates will not see any difference.
# Minimize usage of third party libraries and their components.  When possible, encapsulate code from the third party so that users of the class never see the third party library.  For example, the base class for XML parsing is abstract.  A concrete class for XML parsing is implemented using QT's XML parsing library.  Users call a factory method in abstract XML parser class that returns a parsers.  Delegates that receive the SAX XML tags and characters have no knowledge about the actual implementation of the XML parser.  If fact, the QT  XML parser could be replaced with a different XML parser and the delegates will not see any difference.
-
 
-
== Coding (For October, 2011) ==
 
-
=== Carryover from Sept, 2011 ===
 
-
# (Gifti, Jon, ETC:9/2/2011, Status:In-Progrss, '''NOTE from JWH''': These items have been separated and are in GIFTI directory) Separate read of MetaData, LabelTable, and other elements that are present in multiple files.  These implementation should be moved to the NIFTI library so that they can be used by NIFTI, GIFTI, CIFTI, and Caret XML files.
 
-
# (Nifti Header Reader/Writer, Caret5/6/New, Jon ETC:, Status: DONE) NiftiReader - Implement reading that reads the NIFTI header (version 1 or 2) and any extensions. 
 
-
# (Nifti Volume File Extension, moved to Nifti Reader Writer status update below)....
 
-
# (Common) Implement or remove any stubbed functions.
 
-
# (Files, Caret XML, Caret6) SpecFile (is there a better name, DataSet, DataInventory, DataFileList???  Also write its SAXReader.  For each surface-based data file listed, there will be an attribute that identifies its structure.  '''UPDATE by JWH''': Should a 'SpecFile' be a standardized file like the '*IFTI' files?  Does this relate to what Dan presented, the CFF file?
 
-
 
-
=== New Tasks ===
 
-
# (Nifti, Caret5, Jon, Status: in development)
 
-
## Nifti Header Reader/Writer (Jon, Status:Done)
 
-
## Nifti Extension Reader/Writer (Jon, Status:On hold until after SFN) - currently reads and writes existing extensions, but is unable to parse or interpret extension data.
 
-
## Nifti Matrix Reader/Writer (Jon, Status: On hold until after SFN) Currently reads/writes Nifti Matrix data stored as float32 or float64, and handles byte ordering issues gracefully.  TODO below:
 
-
##* (Jon, Status: DONE) Add support for reading RGB volumes, along with volumes that are stored using integer data types (i.e. 32 bit ints, 64 bit ints, etc.)
 
-
##* (Jon, Status: DONE) Implement slope/intercept data value scaling
 
-
##* (Jon, Status: DONE) Add handling for compressed nifti files (nii.gz)
 
-
##* (Jon, Status: On hold, until after SFN) Add support for loading entire time series into memory (vs. reading a volume frame at a time.) (low priority)
 
-
# (NiftiHelper, Caret5, Jon, Status:On hold until after SFN) - port NiftiHelper from caret5 to caret7.  Nifti helper includes functions for interpreting Nifti matrix scaling, orientation, and center using the NiftiHeader supplied sform and qform matrices.  It also includes conversion routines for sform and qform orientation matrices stored in the Nifti Header file.  This extra level of interpretation will be necessary for caret7 to make use of volumes laid out in non-standard (non-LPI) orientation.
 
-
# (Cifti, Jon, Status: in development) Rewrite Cifti to use Nifti Header Reader/Writer and NiftiMatrix reader so that they both share a common code-base.  Ideally, Cifti will inherit interface from NiftiFile so that they share a common interface.
 
-
# (Cifti, Jon, Status: taken) Add helper routines to Cifti to create sensible defaults for time series and connectivity files.  This should reduce errors when creating files from scratch, and make it quite a bit easier to work with.  Add other helper function to Cifti as needed.
 
-
# (Cifti, Jon, Status: taken) Add row-wise reading to Cifti and test it.  Allow for editing Cifti files on disk, without loading the entire file into memory.  This should happen when rewriting Cifti to use the newly written NiftMatrix reader/writer, but some extra methods and testing will need to happen. 
 
-
# (CiftiXML, Tim, Status: DONE) Implement a more friendly set of functions for accessing the Cifti XML extension
 
-
# (ConnectomeDB, Tim, Status: DONE) Implement Cifti subclass to interface with ConnectomeDB
 
-
# (Common, Tim, Status: DONE) Implement a class for Caret to do http requests through
 
-
# (Brain, Caret6 John, Status: in development) Brain will organize all data loaded into Caret.  It will contain multiple brain structures.  Files that are structure independent are kept within the Brain.  Multiple subjects, which require a one spec file per subject, will require a SessionManager.
 
-
# (Brain, Caret6 John, Status: in development) BrainStructure will contain data for a specific brain structure.  At this time it is used for surface-based data related to the cerebral cortices and the cerebellum.  In the future, it could contain models of sub-cortical structures.  Files are associated with a brain structure by the structure attribute and the number of nodes.  The brain structure will contain all of its surface-based files.
 
-
# (Brain, Caret6 John, Status: in development) Surface extends the SurfaceFile class and contains methods for some surface operations.
 
-
# (Brain, Caret6) DisplaySettings (perhaps DataController) and its subclasses are needed to manage the display status of different data types.
 
-
# (Brain, Caret6/New, John, Status: in development) Controllers (formerly Viewers) control the display of surfaces, volumes, etc. in the Main and Viewing Window graphics areas.
 
-
# (Brain, Caret6, Done, 12 Oct 2011 JWH) DataFileReader Uses Files project classes to read a file.  Note: 'Brain' reads data files.
 
-
# (Brain, Caret6, Done, 12 Oct 2011, JWH) SpecFileReader Reads the selected files into Caret from a SpecFile.  Note: 'Brain' reads the selected files in a Spec File.
 
-
# (Brain, New, Taken, JS) Develop a container format for caret 'projects'.  This could include using CFF as Dan Marcus mentioned, cdb, sqlite, or any other number of approaches.  Since this also may tie into how we manage caret projects with spec files, I will attempt to coordinate this with JWH, among others.
 
-
# (Brain, CIFTI, Files, Caret5/6/New, Status: Taken, Jon) Connectivity data loading and processing.  A bit more clarity needs to be added to describe what kinds of processing we want (cifti average to start?, should this be located in Brain?)
 
-
# (GuiQt, New John, Status: in development) Main Window, toolbar, and menus.
 
-
# (GuiQt, Caret5/New)
 
-
# (GuiQt, Caret6) A window manager class that launches and updates all open windows.
 
-
# (GuiQt, New) Viewing Windows and yoking.
 
-
# (GuiQt, Caret5/New, Done, 12 Oct 2011, JWH) One file selection dialog for all files types (including SpecFile).  It defaults to spec file for the filter.  If additional information is needed, it appear in another dialog.
 
-
# (GuiQt, Caret5/6) Manage Loaded Files Window.
 
-
# (GuiQt, Caret6/New) A multi-page window for use by Display Control and the various operation windows.
 
-
# (Brain, Caret6, Done, 12 Oct 2011, JWH) SurfaceOverlay Maintains data related to a single surface overlay.
 
-
# (Brain, Caret6), Done, 12 Oct 2011, JWH SurfaceOverlayColoring Colors brain structure nodes for specific windows using a set of surface overlays.
 
-
# (Brain, Caret6, Done, 12 Oct 2011, JWH) SurfaceOverlaySet  Maintains a set of surface overlays for a specific window.
 
-
# (Brain, Caret6, On hold until overlay system clearly defined, JWH) Volume Overlays.
 
-
# (Brain, Caret5/Caret6/New, In Work, 12 Oct 2011, JWH) OpenGL rendering, selection.  Initially support fixed pipeline but provide interface that will allow programmable pipeline in the future.
 
-
# (Brain/GuiQt, New) Create mouse and keyboard processing mechanism.  Active one receives input events and provides labels for status bar.
 
-
# (GuiQt, Caret6/New) Display Control Window.
 
-
# (GuiQt. Caret5/6/New) Identification Window.
 
-
# (GuiQt, New) Help system that may use Qt's WebKit implementation.
 
-
# (GuiQt, Brain, Files, Caret6/New, Tim/John, status: in progress) Interface to Connectome DataBase.  Currently supports dense connectivity, should discuss how to communicate what type of cifti a URL is associated with.
 
-
# (GuiQt, New) Capture image(s) dialog.
 
-
# (GuiQt, New, JS) Animation system (rotation, time point sequencing, etc) JS - I spent roughly a year creating an animation toolkit at a previous job.  Many of the concepts could carry over, however, interface design will likely involve JWH, Jenn, and Will.
 
-
# (Common or Animation, New, JS) This will handle the back-end work involved in calculating timelines, performing analysis of dense time series to highlight areas of interest on the timeline, creating smooth spatial rotation to different areas of interest as the time sequence is saved, etc.  It will start very simple, but in the end could have quite a bit of power.)  I think Animation is generic enough that it could be it's own library, or perhaps put in Common.
 
-
# (GuiQt, New) Extend toolbox to allow display of more than one toolbox at a time.  Allow for putting them side by side at the bottom of the viewer to take advantage of wide format displays.
 
-
# (GuiQt, New) Design and implement a Dense Connectivity tab to the toolbox.  Potential features may include saving and loading previously selected nodes, setting threshholds for what connections are displayed, controlling the palette that is used to display connectivity, etc.
 
-
# (GuiQt, New) Closely coupled with the Animation system.  Add a Dense Time Series tab to the toolbox window.  Potential interface elements to start would include a time line, pause, start, stop, rewind, fast-foward. Buttons could be added for loading a dense time series.  The above interface elements don't even cover the minimum requirements for such a windows, but should highlight that it needs it's own space.
 
== Future Tasks ==
== Future Tasks ==

Revision as of 18:31, 14 November 2011

Contents

Development Sequence

Tasks for previous months (updated monthly)

September, 2011

IT Tasks

This is a page for non-development tasks. While not directly related to caret7 development, many of these tasks play a crucial role in our success:
IT Tasks

Procedure for Development

  1. All developers should add this page to their watch list so that they are alerted to any additional items or changes. Others are encouraged to sign up as well.
  2. When taking a task, put your inititials, an ETC (estimated time of completion), and status for that item (either in-progress or DONE).
  3. Please do not take a task that another developer is working on without following the suggestions below. Additionally, do not start a task before indicating that you are taking it.
  4. If an item's requirements, design, or implementation are unclear or controversial, then create an RT ticket, and put a link to it in the particular wiki item. For example, EventManager will require us to form a consensus, which is difficult to do with a wiki page, but easy to do by having a discussion on RT.
  5. If the design of a group of features (such as the names of objects, or GUI design) are un-decided, then an RT ticket should be clear labeled and put under the Design issues heading. This will facilitate the discussion of design related issues outside of meetings and allow us to better coordinate our efforts.
  6. In general, unless an item is a very large task, one developer should perform the implementation, and any concerns about how it is being done should be discussed through the wiki using the discussion page.
  7. Opening an RT ticket related to a development item is possible at any time, including after a task is marked DONE. If there are issues with an item, discussion is encouraged.
  8. At the beginning of each month, completed tasks should be MOVED to a separate page of tasks for the previous month (i.e. DevelopmentStrategy092011), and deleted from the "current tasks" list. Tasks started in the previous month(s), but that aren't finished, should be COPIED to the tasks for previous month, but still kept in the "current tasks" list. (Keeping tasks marked in-progress in both the previous month's tasks list and "current tasks" list should make it easier to spot tasks that took more than one month to complete).


Design and Development Issues

  1. Begin design of graphical-user interface. Create mockup user interfaces using drawings or QtDesigner/QtQuick. Examine Caret5 and Caret6. Determine what MUST be in the user-interface. What can be moved to the command line. Compare Caret5's many menus to Caret6's operation dialogs.
  2. Should Mac version be more Mac-Like? Mac windows normally do not include a close button and are closed by the red circle in the top left corner.
  3. Begin creating a list of commands for command line processing.
  4. Begin writing user documentation.
  5. Icons
  6. File Naming Convention

Development Environment

  1. 64-bit only as a goal. We will be doing 32-bit builds in house currently, and will test user reaction in October. If needed we can do a 32 bit release, or drop 32 bit support completely at that point.
  2. A build system that runs as files are checked into source control needs to be created. If there compilation or testing errors, emails are sent to developers.
  3. Investigate CTest, CDash, and CPack for use with build system. - TSC: CTest is now in use, but not connected to a dashboard
  4. Examine CppTest for unit testing.
  5. Minimize usage of third party libraries and their components. When possible, encapsulate code from the third party so that users of the class never see the third party library. For example, the base class for XML parsing is abstract. A concrete class for XML parsing is implemented using QT's XML parsing library. Users call a factory method in abstract XML parser class that returns a parsers. Delegates that receive the SAX XML tags and characters have no knowledge about the actual implementation of the XML parser. If fact, the QT XML parser could be replaced with a different XML parser and the delegates will not see any difference.

Future Tasks

  1. (Common) Preferences - This will likely encapsulate Qt's preferences class.
  2. (Files, GIFTI-based) SurfaceRegionOfInterest
  3. (Command Line, Tim, Status: started, on hold) Begin writing command line operations. Currently have metric smoothing and metric gradient implemented.
  4. (Command Line) Command that converts a coordinate and a topology file to a surface file.
  5. (GuiQt) Metric Operations Window (uses multi-page windows).
  6. (GuiQt) Label Operations Window (uses multi-page windows).
  7. (GuiQt) Shape Operations Window (uses multi-page windows).
  8. (GuiQt) Surface Region of Interest Window (Wizard)
  9. (GuiQt) BrainTips.
  10. (Files, Caret XML) The coordinate of border point or a focus is one or more of stereotaxic (cartesian), barycentric, or "van essen". As a result, a common object that supports each of these coordinates is extended or encapsulated. When the coordinate is stereotaxic, the file is essentially a Caret5 BorderFile or FociFile. In addition this object will also include a structure attributes. When a focus projects ambiguously, it will contain two or more of these objects.
  11. (Files, Caret XML) BorderProjection and its SAXReader.
  12. (Files, Caret XML) FociProjection and its SAXReader.
  13. (Files) Point location algorithm.
  14. (Files) Point projection algorithm.
  15. (Files) Algorithm SurfaceProjector for Foci and Borders.
  16. (Files) Algorithm SurfaceUnprojector for Foci and Borders.
  17. (Files, Caret XML) Annotation and its SAXReader.
  18. (Files, Caret XML) FociSearch and its SAXReader.
  19. (Files, Caret XML) Study (and its related elements) and its SAXReader.
  20. (Files, Caret XML) StudyCollection and its SAXReader.
  21. (GuiQt) Border Operations Window (uses multi-page windows).
  22. (GuiQt) Foci Operations Window (uses multi-page windows).
  23. (GuiQt) Study Operations Window (uses multi-page windows).
  24. (GuiQt) Vocabulary Operations Window (uses multi-page windows).
  25. (Brain) Mapping Surface Data to Volumes.
  26. (GuiQt) Gui for mapping surface data to volumes.
  27. (Brain) Mapping Volume (Atlas) Data to Surfaces.
  28. (GuiQt) Gui for Mapping Volume (Atlas) Data to Surfaces.
  29. (Brain) Mapping Volume (Individual) Data to Surfaces.
  30. (GuiQt) Gui for Mapping Volume (Individual) Data to Surfaces.
  31. (Brain) Multiresolution morphing.
  32. (Brain) Surface-based Registration.
  33. (GuiQt) Geometry Operations Window.
  34. (GuiQt) Topology Operations Window.
  35. (GuiQt) Registration Operations Window.
  36. (Gifti) For statistics randomization, a special GIFTI reader that allows sequential reading of data arrays is needed. This means that after an array is read, the data is passed to a callback or interface method that processes the data. These operations are repeated until all data has been read. Similar functionality is also needed for writing of GIFTI files.
  37. (Statistics) Implement inferential and significance statistical algorithms.
  38. (Statistics) Use GLM for inferential statistics?
  39. (Caret5) Add ability or caret_command (carert5) to write Caret6 format data files including spec file.
  40. (Files) Add ability to read legacy file formats. Possibly command line only.
  41. SureFit an optional library that may require VTK.
  42. Get nightly builds and tests running consistently on all platforms. Continue to standardize development environment.
  43. Before releasing workbench to the public take advantage of this opportunity to create official time windows of support for each release, that give the user a set of guidelines for when they will need to upgrade their systems to continue using the latest workbench features (i.e. If you want to run workbench, you will need to use this release or later of your favorite OS). Enacting a well-defined support window (or life-cycle) will greatly reduce time wasted tracking down arcane and esoteric problems compatibility problmes that take a great deal of time to fix but benefits only a very small set of users.

Other

  • Command classes should be callable from within Caret7 (as in Caret6).
  • Encapsulate Qt when possible.
  • Do not use QThread, use OpenMP.
Personal tools
Sums Database