update release notes

doc/release_notes.tex

@@ -1280,6 +1280,373 @@ \subsection*{Bug fixes}
 \end{itemize}
 
 \section{PsPM Version 7.0.0}
+\subsection*{General}
+\begin{itemize}
+\item PsPM now has an online reference.
+
+\item The default path will be automatically added when running pspm\_init.
+
+\item The help text in PsPM has been reviewed and updated.
+
+\item The consistency of PsPM logic has been reviewed and improved.
+
+\item Data importing features were reviewed and improved.
+\end{itemize}
+
+\subsection*{GUI}
+
+\begin{itemize}
+\item Description text of functions for improving readability.
+
+\item Channel processing is now done by universal functions for improving robustness and consistency.
+
+\item GUI has been updated for compatibility with MATLAB version 2019--2024.
+
+\item Deprecated modules have been removed.
+
+\item Now PsPM can be started up at MATLAB 2019--2024 smoothly without issues.
+
+\item Now PsPM's main GUI is displaying properly. Previously the GUI colour was not displaying.
+
+\item Now the ACQ importing feature is organised consistently to other importing features.
+
+\item GUI functions have been updated to keep consistency.
+
+\item Plots are now consistently using the label style "measurement [unit]".
+
+\item The text in the input blocks for pspm\_display is now displaying properly.
+
+\item Unexpected blank lines in help text are now removed.
+
+\item GUI functions (display, data\_editor, ecg\_editor, review) are reviewed for improving consistency.
+\end{itemize}
+
+\subsection*{New Features}
+
+\begin{itemize}
+\item New HPR model based on Xia, Liu et al.
+
+\item Provided as pspm\_bf\_hprf\_rew.
+\end{itemize}
+
+\subsection*{Improvements}
+\begin{itemize}
+\item General
+
+\begin{itemize}
+\item New helper function for processing multiple data channel simultaneously.
+
+\item Functions always work on one data file only unless explicitly designed to work on multiple files.
+
+\item Functions that write data into channels always return [sts, channel\_index] and potentially further output arguments, and functions that create new files always return [sts, newfilename] and potentially further output arguments.
+
+\end{itemize}
+
+\item pspm\_check\_data
+
+\begin{itemize}
+\item A new function for checking input data, now used by pspm\_load\_data and pspm\_write\_channel.
+
+\item pspm\_check\_python, pspm\_check\_python\_modules, pspm\_find\_python
+
+\item New functions checking python modules for calling corresponding packages.
+\end{itemize}
+
+\item pspm\_combine\_markerchannels
+
+\begin{itemize}
+\item Now pspm\_combine\_markerchannels only process one specific data file or data channel.
+\end{itemize}
+
+\item pspm\_convert\_hb2hp
+
+\begin{itemize}
+\item Improved interpolation by using nearest neighbour instead of linear extrapolation (including a new regression test).
+\end{itemize}
+
+\item pspm\_dcm
+
+\begin{itemize}
+\item Now the option depth has been implemented. The option can invert an entire session at the same time.
+\end{itemize}
+
+\item pspm\_extract\_segments
+
+\begin{itemize}
+\item Updated missing epoch checking.
+
+\item Incomplete options will no longer give warnings, instead, it will use the default values.
+
+\item GUI has been updated for corresponding the function updates.
+
+\item Compatibility with pspm\_glm has been improved.
+\end{itemize}
+
+\item pspm\_get\_eyelink
+
+\begin{itemize}
+\item Now it will import not only ethernet ('msg') but also parallel/serial ('input') input to Eyelink eyetracker.
+\end{itemize}
+
+\item pspm\_get\_timing
+
+\begin{itemize}
+\item Now catches an edge case in epoch definition (negative epoch onsets).
+\end{itemize}
+
+\item pspm\_glm
+
+\begin{itemize}
+\item Unnecessary and impossible orthogonalisation in edge case has been removed.
+
+\item Now allows saving events.
+
+\item Computation of events in case of edge cases were corrected.
+
+\item The output now includes time stamps for troubleshooting.
+\end{itemize}
+
+\item pspm\_import
+
+\begin{itemize}
+\item Now only one data file is allowed to be processed by this function.
+\end{itemize}
+
+\item pspm\_interpolate
+
+\begin{itemize}
+\item Only one data file is allowed to be processed, and multiple data files are no longer supported.
+
+\item One or all data channel(s) are accepted, and multiple selected data channels are no longer supported. Correspondingly, pspm\_load\_channel and pspm\_select\_channels are used for handling a single channel or all channels, respectively. To select all the data channels, the channel specification needs to be all.
+
+\item An input as struct is no longer supported.
+
+\item Extrapolation has been improved by avoiding adding unsolicited 1 in the beginning.
+\end{itemize}
+
+\item pspm\_load\_channel
+
+\begin{itemize}
+\item Updated to allow detecting whether a channel is a wave or events channel.
+
+\item Function will no longer terminate if wrong channel type is provided, instead, it will give a warning and continue processing.
+\end{itemize}
+
+\item pspm\_logical2epochs
+
+\begin{itemize}
+\item New function that processes index values.
+\end{itemize}
+
+\item pspm\_merge
+
+\begin{itemize}
+\item Now only one data file is allowed to be processed by this function.
+\end{itemize}
+
+\item pspm\_options
+
+\begin{itemize}
+\item Updated for pspm\_interpolate to deal with the larger number of methods allowed.
+\end{itemize}
+
+\item pspm\_pupil\_pp
+
+\begin{itemize}
+\item Improved by using a different criterion for the decision on whether to combine pupils.
+\end{itemize}
+
+\item pspm\_rename
+
+\begin{itemize}
+\item The function, previously known as pspm\_ren, has been renamed for enhanced transparency.
+
+\item pspm\_rename now uses pspm\_load\_data to save data and checks whether new file already exist.
+\end{itemize}
+
+\item pspm\_resp\_pp
+
+\begin{itemize}
+\item Improved interpolation by using nearest neighbour instead of linear extrapolation (including a new regression test).
+\end{itemize}
+
+\item pspm\_scr\_pp
+
+\begin{itemize}
+\item Now only one data file is allowed to be processed by this function.
+\end{itemize}
+
+\item pspm\_select\_channel
+
+\begin{itemize}
+\item pupil and pupil\_missing are no longer confused.
+\end{itemize}
+
+\item pspm\_split\_sessions
+
+\begin{itemize}
+\item Now uses pspm\_trim.
+\end{itemize}
+
+\item pspm\_trim
+
+\begin{itemize}
+\item Now only one data file is allowed to be processed by this function.
+
+\item Now able to trim missing epoch files.
+
+\item Now uses pspm\_load\_channel for data processing.
+
+\item Now catch an edge case in epoch definition (negative epoch onsets).
+\end{itemize}
+
+\item pspm\_write\_channel
+
+\begin{itemize}
+\item pspm\_write\_channel now uses pspm\_select\_channels for checking channels.
+\end{itemize}
+
+\subsection*{Bug fixes}
+
+\item General
+
+\begin{itemize}
+\item Data channel index handling has been updated.
+\end{itemize}
+
+\item GUI
+
+\begin{itemize}
+\item Buttons, which previously did not respond when being clicked, have been working properly now.
+
+\item Main GUI colour profile has been reviewed and re-adjusted.
+
+\item The feature artefact removal now displays the option change data.
+
+\item The Data convert item appears under Tools in the main GUI, which was previously non-selectable, is now working properly.
+
+\item The pspm\_display GUI, previously threw a warning when called with full file path, has been working properly now.
+
+\item The pspm\_data\_editor GUI, previously did not show the output file when specified, has been working properly now.
+
+\item An issue that appears when PsPM starts up, which is related to path, has been fixed.
+
+\item An issue that causes GUI colour missing has been fixed.
+\end{itemize}
+
+\item pspm\_check\_data
+
+\begin{itemize}
+\item Ensure backwards data file compatibility by modifying wrong markerinfo handling.
+\end{itemize}
+
+\item pspm\_combine\_markerchannels
+
+\begin{itemize}
+\item Incorrect processing for markerinfo.name, which previously created a char rather than a cell array, has been fixed.
+\end{itemize}
+
+\item pspm\_data\_editor
+
+\begin{itemize}
+\item A bug causing incorrect Y axis display has been fixed.
+
+\item A bug causing unsuccessful initialisation of handles.options has been fixed.
+\end{itemize}
+
+\item pspm\_dcm / pspm\_dcm\_inv
+
+\begin{itemize}
+\item A bug, which makes inf not recognised properly by pspm\_options, has been fixed.
+\end{itemize}
+
+\item pspm\_display
+
+\begin{itemize}
+\item An issue, which caused failure of running pspm\_display, has been fixed.
+\end{itemize}
+
+\item pspm\_extract\_segments
+
+\begin{itemize}
+\item A bug, which improperly normalised with missing value, has been fixed.
+\end{itemize}
+
+\item pspm\_get\_eyelink
+
+\begin{itemize}
+\item A bug causing marker importing has been fixed.
+\end{itemize}
+
+\item pspm\_get\_markerinfo
+
+\begin{itemize}
+\item Function is updated by improving data checking for avoiding importing bugs.
+\end{itemize}
+
+\item pspm\_get\_timing
+
+\begin{itemize}
+\item The function used to cause problem running GLM with conditions created from marker info, now it is fixed.
+\end{itemize}
+
+\item pspm\_glm
+
+\begin{itemize}
+\item A GUI issue has been fixed.
+
+\item An issue, which caused incorrect trial exclusion, has been addressed.
+
+\item An issue, which was caused by pmod setting, has been fixed.
+
+\item The option overwrite is now adjustable through GUI.
+
+\item GLM for SPS now parse the modelling properly if "best eye" is selected.
+
+\item A bug related to incorrect sample rate has been fixed.
+\end{itemize}
+
+\item pspm\_init
+
+\begin{itemize}
+\item Duplicated path removal has been removed.
+\end{itemize}
+
+\item pspm\_multi2index
+
+\begin{itemize}
+\item A bug related to missing index for a vector has been fixed.
+\end{itemize}
+
+\item pspm\_options
+
+\begin{itemize}
+\item A bug that caused incorrect function calling has been fixed.
+
+\item Argument updates for some functions, pspm\_pp.
+\end{itemize}
+
+\item pspm\_process\_illuminance
+
+\begin{itemize}
+\item options.missing, when specified as "no missing epochs", can allow processing as expected and no longer give warnings.
+\end{itemize}
+
+\item pspm\_scr\_pp
+
+\begin{itemize}
+\item A bug that causes unsuccessful data loading has been fixed.
+\end{itemize}
+
+\item pspm\_trim
+\begin{itemize}
+\item pspm\_trim` no longer exits if the missing epochs are empty.
+\end{itemize}
+\end{itemize}
+\subsubsection*{New test functions}
+\begin{itemize}
+\item New test functions for Python package calling have been added.
+\end{itemize}
 
 \bibliographystyle{pnas2009}
 \bibliography{PsPM}