Code for localization of mouse ultrasonic vocalizations using a microphone array
Switch branches/tags
Nothing to show
Clone or download
adamltaylor Added documentation of r_est_from_clip_simplified.m, modified README …
…to point user at that function, updated test_with_synthetic_data to work properly with that function.
Latest commit 78b949a May 26, 2015
Permalink
Failed to load latest commit information.
bin Validation figure code seems to run on cluster, but not sure it's cor… Oct 21, 2013
motr @ c01d9d5 Added TMT (release 1.14) and Motr (latest commit as of 2014/01/02) as… Jan 2, 2014
tmt @ 2760e6c Added TMT (release 1.14) and Motr (latest commit as of 2014/01/02) as… Jan 2, 2014
toolbox Added documentation of r_est_from_clip_simplified.m, modified README … May 26, 2015
.gitattributes Changed .gitattributes so that it keeps the unix-style line endings f… Jul 8, 2014
.gitignore Updated files to work with new submodule-ized Muse repo, and to work … Jan 3, 2014
.gitmodules Added TMT (release 1.14) and Motr (latest commit as of 2014/01/02) as… Jan 2, 2014
.hgignore Added function fig_segment_ssl_summary.m, make a nice figure showing … Oct 31, 2013
README.txt Added documentation of r_est_from_clip_simplified.m, modified README … May 26, 2015
compare_localization_alt_vs_jpn.m Added code to use Josh's estimates of position for single-mouse data … Oct 29, 2013
compile_feval_analysis_function_executable.m Validation figure code seems to run on cluster, but not sure it's cor… Oct 21, 2013
fig_segment_ssl_summary_example.m Updated files to work with new submodule-ized Muse repo, and to work … Jan 3, 2014
fig_segment_ssl_summary_example_multi_mouse.m Updated files to work with new submodule-ized Muse repo, and to work … Jan 3, 2014
fig_spectrogram_ssl_dB_example.m Code for Josh to make summary segment figs, nice spectrgrams ready to… Nov 1, 2013
figure_validation.m Added some code for looking at single segments in detail. Oct 28, 2013
figure_validation_using_joshs_output.m Modified code to extract chest positions of fake mice for Josh. Jul 10, 2014
figure_validation_using_joshs_output_one_nearby_fake_mouse.m Modified code to extract chest positions of fake mice for Josh. Jul 10, 2014
gather_r_est_jobs_for_snippetized_single_mouse_data.m Code now producing percent of single-mouse segments correctly assigne… Oct 23, 2013
generate_r_est_for_single_mouse_data_snippetized.m Cleaned out some old functions. Oct 21, 2013
methods_figure_rsrp_maps_and_estimate_panels.m Minor changes to file paths on Windows. Aug 27, 2014
methods_figure_rsrp_maps_and_estimate_panels_for_other_segments.m Added functions to generate additional methods figures for multi-mous… Jan 3, 2014
methods_figure_traces_and_spectrogram_panels.m Minor changes to file paths on Windows. Aug 27, 2014
methods_figure_traces_and_spectrogram_panels_for_other_segments.m Added functions to generate additional methods figures for multi-mous… Jan 3, 2014
methods_figure_video_frame_panels.m Updated files to work with new submodule-ized Muse repo, and to work … Jan 3, 2014
modpath.m Updated files to work with new submodule-ized Muse repo, and to work … Jan 3, 2014
multi_mouse_rsrp_maps_and_estimate_panels.m Fixed some bugs with processing multi-mouse data. Also added parsejpg… Nov 4, 2013
rec_pb_3_jpn.m Modified README, added data acquisition script from Josh. Apr 15, 2015
run_one_segment_with_high_verbosity.m Minor change for windows paths to egnor data. Aug 27, 2014
scatter_r_est_jobs_for_snippetized_single_mouse_data.m Converted everything to using normal Cartesian coords for everything,… Oct 30, 2013
test_with_synthetic_data.m Added documentation of r_est_from_clip_simplified.m, modified README … May 26, 2015
video_frame_panels_multimouse.m Updated files to work with new submodule-ized Muse repo, and to work … Jan 3, 2014

README.txt

This is Muse, which stands for Mouse Ultrasonic Source Estimator.  It
does sound-source localization of ultrasonic mouse vocalizations.

The core function of Muse is r_est_from_clip_simplified(), located in
toolbox/r_est_from_clip_simplified.m.  See the documentation within
that file for how to invoke it and how to interpret its output.  This
was the function used to estimate position from individual "snippets"
in Neunuebel et al. 2015.  You can run the script
test_with_synthetic_data.m to see an example of how to call
r_est_from_clip_simplified() on, you guessed it, synthetic data.

This version of Muse depends on the Matlab Signal Processing and
Statistics toolboxes, and on the Taylor Matlab Toolbox, release
1.14.

A MATLAB-based data acquisition function that uses a National
Instruments board (rec_pb_3_jpn.m) is included in the repository, but
vocalizations can also be recorded using your favorite data
acquisition software.  To prepare vocalizations for localization, they
should almost certainly should be cut out using Ax
(https://github.com/JaneliaSciComp/Ax).

All code in Muse, except that in toolbox/snippeter, is copyright Adam
L. Taylor, 2013-2015.  It is licensed under the BSD 2-clause license.
(See below.)

Copyright (c) 2013-2015, Adam L. Taylor
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the
   distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation
are those of the authors and should not be interpreted as representing
official policies, either expressed or implied, of Adam L. Taylor or
the Howard Hughes Medical Institute.