' + _('Hide Search Matches') + '
') + .appendTo($('#searchbox')); } }, @@ -213,7 +213,7 @@ var Documentation = { * helper function to hide the search marks again */ hideSearchWords : function() { - $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); + $('#searchbox .highlight-link').fadeOut(300); $('span.highlighted').removeClass('highlighted'); }, diff --git a/_static/down-pressed.png b/_static/down-pressed.png new file mode 100644 index 00000000..6f7ad782 Binary files /dev/null and b/_static/down-pressed.png differ diff --git a/_static/down.png b/_static/down.png new file mode 100644 index 00000000..3003a887 Binary files /dev/null and b/_static/down.png differ diff --git a/_static/pygments.css b/_static/pygments.css index 1a14f2ae..d79caa15 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -13,11 +13,11 @@ .highlight .gr { color: #FF0000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #303030 } /* Generic.Output */ +.highlight .go { color: #333333 } /* Generic.Output */ .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ diff --git a/_static/searchtools.js b/_static/searchtools.js index dae92b5e..663be4c9 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -1,6 +1,6 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~ + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ * * Sphinx JavaScript utilties for the full-text search. * @@ -36,10 +36,11 @@ jQuery.makeSearchSummary = function(text, keywords, hlwords) { return rv; } + /** * Porter Stemmer */ -var PorterStemmer = function() { +var Stemmer = function() { var step2list = { ational: 'ate', @@ -300,20 +301,20 @@ var Search = { }, query : function(query) { - var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in', - 'if', 'for', 'no', 'there', 'their', 'was', 'is', - 'be', 'to', 'that', 'but', 'they', 'not', 'such', - 'with', 'by', 'a', 'on', 'these', 'of', 'will', - 'this', 'near', 'the', 'or', 'at']; - - // stem the searchterms and add them to the correct list - var stemmer = new PorterStemmer(); + var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; + + // Stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); var searchterms = []; var excluded = []; var hlterms = []; var tmp = query.split(/\s+/); - var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; + var objectterms = []; for (var i = 0; i < tmp.length; i++) { + if (tmp[i] != "") { + objectterms.push(tmp[i].toLowerCase()); + } + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || tmp[i] == "") { // skip this "word" @@ -344,9 +345,6 @@ var Search = { var filenames = this._index.filenames; var titles = this._index.titles; var terms = this._index.terms; - var objects = this._index.objects; - var objtypes = this._index.objtypes; - var objnames = this._index.objnames; var fileMap = {}; var files = null; // different result priorities @@ -357,40 +355,19 @@ var Search = { $('#search-progress').empty(); // lookup as object - if (object != null) { - for (var prefix in objects) { - for (var name in objects[prefix]) { - var fullname = (prefix ? prefix + '.' : '') + name; - if (fullname.toLowerCase().indexOf(object) > -1) { - match = objects[prefix][name]; - descr = objnames[match[1]] + _(', in ') + titles[match[0]]; - // XXX the generated anchors are not generally correct - // XXX there may be custom prefixes - result = [filenames[match[0]], fullname, '#'+fullname, descr]; - switch (match[2]) { - case 1: objectResults.push(result); break; - case 0: importantResults.push(result); break; - case 2: unimportantResults.push(result); break; - } - } - } - } + for (var i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0,i), + objectterms.slice(i+1, objectterms.length)) + var results = this.performObjectSearch(objectterms[i], others); + // Assume first word is most likely to be the object, + // other words more likely to be in description. + // Therefore put matches for earlier words first. + // (Results are eventually used in reverse order). + objectResults = results[0].concat(objectResults); + importantResults = results[1].concat(importantResults); + unimportantResults = results[2].concat(unimportantResults); } - // sort results descending - objectResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - importantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - unimportantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - // perform the search on the required terms for (var i = 0; i < searchterms.length; i++) { var word = searchterms[i]; @@ -489,7 +466,7 @@ var Search = { listItem.slideDown(5, function() { displayNextItem(); }); - }); + }, "text"); } else { // no source available, just display title Search.output.append(listItem); @@ -510,9 +487,74 @@ var Search = { } } displayNextItem(); + }, + + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var importantResults = []; + var objectResults = []; + var unimportantResults = []; + + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + var match = objects[prefix][name]; + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (var i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + anchor = match[3]; + if (anchor == '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + result = [filenames[match[0]], fullname, '#'+anchor, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + return [importantResults, objectResults, unimportantResults] } } $(document).ready(function() { Search.init(); -}); +}); \ No newline at end of file diff --git a/_static/sidebar.js b/_static/sidebar.js index e9ef491c..a45e1926 100644 --- a/_static/sidebar.js +++ b/_static/sidebar.js @@ -29,6 +29,9 @@ $(function() { var sidebar = $('.sphinxsidebar'); var sidebarwrapper = $('.sphinxsidebarwrapper'); + // for some reason, the document has no sidebar; do not run into errors + if (!sidebar.length) return; + // original margin-left of the bodywrapper and width of the sidebar // with the sidebar expanded var bw_margin_expanded = bodywrapper.css('margin-left'); diff --git a/_static/underscore.js b/_static/underscore.js index 9146e086..5d899143 100644 --- a/_static/underscore.js +++ b/_static/underscore.js @@ -1,3 +1,10 @@ +// Underscore.js 0.5.5 +// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. +// Underscore is freely distributable under the terms of the MIT license. +// Portions of Underscore are inspired by or borrowed from Prototype.js, +// Oliver Steele's Functional, and John Resig's Micro-Templating. +// For all details and documentation: +// http://documentcloud.github.com/underscore/ (function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e\
+ \
+
\
+ ';
+
+ var replyTemplate = '\
+ \
+
\
+ \
+ \ + <%username%>\ + \ + <%time.delta%>\ +
\ +<#text#>
\
+ \ + \ + reply ▿\ + proposal ▹\ + \ + \ + \ +
\ +\ +<#proposal_diff#>\ +\ +
+
+
+
+
+
\ No newline at end of file
diff --git a/developers.html b/developers.html
new file mode 100644
index 00000000..f4dce4d4
--- /dev/null
+++ b/developers.html
@@ -0,0 +1,180 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ API reference¶
+This is a complete api reference to the openpiv python module.
+
+
+The openpiv.preprocess module¶
+This module contains a pure python implementation of the basic +cross-correlation algorithm for PIV image processing.
+
+
+The openpiv.tools module¶
+The openpiv.tools module is a collection of utilities and tools.
+
+
+The openpiv.pyprocess module¶
+This module contains a pure python implementation of the basic +cross-correlation algorithm for PIV image processing.
+
+
+The openpiv.process module¶
+This module is dedicated to advanced algorithms for PIV image analysis.
+
+
+The openpiv.lib module¶
+A module for various utilities and helper functions
+
+
+The openpiv.filters module¶
+The openpiv.filters module contains some filtering/smoothing routines.
+
+
+The openpiv.validation module¶
+A module for spurious vector detection.
+
+
+The openpiv.scaling module¶
+Scaling utilities
+
+
+
+
+
+
\ No newline at end of file
diff --git a/downloads_page.html b/downloads_page.html
new file mode 100644
index 00000000..bd49810b
--- /dev/null
+++ b/downloads_page.html
@@ -0,0 +1,133 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information for developers and contributors¶
+OpenPiv need developers to improve further. Your support, code and contribution is very welcome and +we are grateful you can provide some. Please send us an email to openpiv-develop@lists.sourceforge.net +to get started, or for any kind of information.
+We use git for development version control, and we have a main repository on github.
+
+
+Development workflow¶
+This is absolutely not a comprehensive guide of git development, and it is only an indication of our workflow.
+-
+
Download and install git. Instruction can be found here.
+
+Set up a github account.
+
+Clone OpenPiv repository using:
++git clone http://github.com/alexlib/openpiv-python.git
+
+create a branch new_feature where you implement your new feature.
+
+Fix, change, implement, document code, ...
+
+From time to time fetch and merge your master branch with that of the main repository.
+
+Be sure that everything is ok and works in your branch.
+
+Merge your master branch with your new_feature branch.
+
+Be sure that everything is now ok and works in you master branch.
+
+Send a pull request.
+
+Create another branch for a new feature.
+
+
+
+Which language can i use?¶
+As a general rule, we use Python where it does not make any difference with code speed. In those situations where Python speed is +the bottleneck, we have some possibilities, depending on your skills and background. If something has to be written from scratch +use the first language from the following which you are confortable with: cython, c, c++, fortran. If you have existing, debugged, tested code that +you would like to share, then no problem. We accept it, whichever language may be written in!
+
+
+Things OpenPiv currently needs, (in order of importance)¶
+-
+
- The implementation of advanced processing algorithms +
- Good documentations +
- Flow field filtering and validation functions +
- Cython wrappers for c/c++ codes. +
- a good graphical user interface +
+
+
+
+
+
\ No newline at end of file
diff --git a/faq.html b/faq.html
new file mode 100644
index 00000000..3ded678a
--- /dev/null
+++ b/faq.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Download OpenPIV Example¶
+
+
+Tutorial files¶
+These are zip files containing sample images and python scripts for analysing them with OpenPIV. These files are included in the source code if cloned from the Git.
+Part 1: how to process an image pair. source code and sample images
+Part 2: how to process in batch a list of image pairs. source code and sample images
+
+
+
+
+
+
\ No newline at end of file
diff --git a/genindex.html b/genindex.html
index 9156cf97..13b9d190 100644
--- a/genindex.html
+++ b/genindex.html
@@ -1,19 +1,24 @@
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+ Frequently Asked Questions¶
+
+
+OpenPIV - what is it for?¶
+OpenPIV is an initiative of scientists to develop a software, algorithms and methods for the state-of-the-art experimental tool of Particle Image Velocimetry (PIV) which are free, open source, and easy to operate. +OpenPIV is the successor of the well known URAPIV software - it is faster, more friendly and much more flexible. +OpenPIV is provided using Matlab, Python or 32bit Windows executable (based on C++ and Qt source).
+
+
+How to cite this work¶
+Taylor, Z.J.; Gurka, R.; Kopp, G.A.; Liberzon, A.; , “Long-Duration Time-Resolved PIV to Study Unsteady Aerodynamics,” Instrumentation and Measurement, IEEE Transactions on , vol.59, no.12, pp.3262-3269, Dec. 2010 +doi: 10.1109/TIM.2010.2047149 +URL: http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=5464317&isnumber=5609237
+
+
+How to contribute ?¶
+Python or Matlab versions:
+-
+
- Open Github account +
- Visit our Git repositories through https://github.com/openpiv +
- Fork Matlab, Python or C++ repository +
- Fix, commit, push to your repository and send us a pull request. +
- Register on openpiv-develop mailing list through http://sf.net/projects/openpiv +
+
+How to download the C++/Qt version¶
+Visit http://www.openpiv.net for the direct links to various versions
+
+
+Getting started tutorials¶
+See the screencast http://www.youtube.com/watch?v=63o-UpKgxF0 of our Matlab version.
+Python and C++ versions video tutorials are in preparation.
+
+
+Support and documentation¶
+How to get support? Where to ask questions?
+-
+
- Sourceforge.net forums https://sourceforge.net/projects/openpiv/support[[BR]] +
- e-mail to openpiv2008@gmail.com +
- Open a feature request or bug issue on Github. +
Navigation
-
-
@@ -59,7 +109,7 @@ Index
+Index
+ +
+ O
+
+
+O
+
|
+
|
+
-
-
Index
\ No newline at end of file diff --git a/np-modindex.html b/gui_doc.html similarity index 53% rename from np-modindex.html rename to gui_doc.html index beab1e4b..44a242b6 100644 --- a/np-modindex.html +++ b/gui_doc.html @@ -3,17 +3,20 @@ + -Navigation
-
-
-
+
@@ -99,10 +62,18 @@ Python Module Index
- -
- o
-
-
- | - o | ||
| - | - openpiv | - |
| - | - openpiv.filters | - |
| - | - openpiv.pyprocess | - |
| - | - openpiv.scaling | - |
| - | - openpiv.tools | - |
| - | - openpiv.validation | - |
+
The OpenPIV graphical user interface¶
+Under construction ...
+
\ + Sort by:\ + best rated\ + newest\ + oldest\ +
\ +\ +
Add a comment\ + (markup):
\ +