Skip to content

Commit 64fcb93

Browse files
committed
R2024b maintenance cycle
1 parent 0cd208b commit 64fcb93

File tree

16 files changed

+51
-112
lines changed

16 files changed

+51
-112
lines changed

.github/workflows/ci.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ on:
88
branches: [ release ]
99
workflow_dispatch:
1010

11+
# Add permission to write GitHub pages
1112
permissions:
12-
contents: read
13+
contents: write
1314
pages: write
1415
id-token: write
1516

@@ -39,6 +40,7 @@ jobs:
3940
release: ${{ matrix.MATLABVersion }}
4041
products: Simulink Signal_Processing_Toolbox Symbolic_Math_Toolbox
4142

43+
4244
# Run all the tests
4345
- name: Run SmokeTests
4446
uses: matlab-actions/run-command@v2
@@ -83,7 +85,8 @@ jobs:
8385
uses: matlab-actions/run-command@v2
8486
with:
8587
command: openProject(pwd); PostSmokeTest;
86-
88+
89+
# Deploy reports to GitHub pages
8790
- name: Setup Pages
8891
uses: actions/configure-pages@v5
8992
- name: Upload pages artifact

.gitignore

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,5 @@ codegen/
4747
# Project settings
4848
Utilities/ProjectSettings.mat
4949

50-
# Test results
51-
SoftwareTests/TestResults_*
52-
53-
# GitLab page fodler
54-
public/
50+
# GitLab page folder
51+
public/

MainMenu.mlx

-105 Bytes
Binary file not shown.

README.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11

2-
<a name="T_DEF03274"></a>
3-
42
# <span style="color:rgb(213,80,0)">Digital Signal Processing: Signals and Filter Design</span>
5-
<a name="H_053613DF"></a>
63

7-
[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://uk.mathworks.com/matlabcentral/fileexchange/171574-introduction-to-digital-signal-processing) or [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Introduction-To-Digital-Signal-Processing&project=DSP.prj&file=README.mlx)
84

9-
[![MATLAB Versions Tested](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FMathWorks-Teaching-Resources%2FDSP-Signals-and-Filter-Design%2Frelease%2FImages%2FTestedWith.json)](https://mathworks-teaching-resources.github.io/DSP-Signals-and-Filter-Design/)
5+
[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/171574-digital-signal-processing-signals-and-filter-design) or [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/DSP-Signals-and-Filter-Design&project=DSP.prj&file=README.mlx)
6+
7+
[![MATLAB Versions Tested](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FMathWorks-Teaching-Resources%2FDSP-Signals-and-Filter-Design%2Frelease%2FImages%2FTestedWith.json)](https://MathWorks-Teaching-Resources.github.io/DSP-Signals-and-Filter-Design)
108

119
**Curriculum Module**
1210

@@ -16,7 +14,6 @@ _Created with R2024a. Compatible with R2024a and later releases._
1614

1715
This curriculum module is comprised of interactive [MATLAB® live scripts](https://www.mathworks.com/products/matlab/live-editor.html) and apps containing examples, exercises, and visualizations of key signal processing concepts.
1816

19-
<a name="H_F00D98E4"></a>
2017

2118
## Background
2219

@@ -29,13 +26,11 @@ The instructions inside the live scripts will guide you through the exercises an
2926

3027
Contact the [MathWorks teaching resources team](mailto:[email protected]) if you would like to provide feedback, or if you have a question.
3128

32-
<a name="H_30BC7141"></a>
3329

3430
## Prerequisites
3531

3632
This module assumes very basic knowledge of Fourier analysis and convolution. If you would like to refresh your knowledge on these concepts, consider checking out [this Fourier Analysis courseware module](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Fourier-Analysis&project=fourier-analysis.prj) and [this live script covering convolution](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Convolution-Digital-Signal-Processing&project=Convolution.prj&file=ConvolutionFilters.mlx) as it relates to filtering.
3733

38-
<a name="H_330E72C3"></a>
3934

4035
## Getting Started
4136
### Accessing the Module
@@ -45,64 +40,63 @@ Use the [<img src="Images/image_1.png" width="136" alt="image_1.png">](https://m
4540

4641
### **On Desktop:**
4742

48-
Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts and double\-click on [DSP.prj](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Introduction-To-Digital-Signal-Processing&project=DSP.prj). It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start.
43+
Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts and double\-click on [DSP.prj](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/DSP-Signals-and-Filter-Design&project=DSP.prj&file=README.mlx). It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start.
4944

5045

51-
Ensure you have all the required products ([listed below](#H_E850B4FF)) installed. If you need to include a product, add it using the Add\-On Explorer. To install an add\-on, go to the **Home** tab and select <img src="Images/image_2.png" width="16" alt="image_2.png"> **Add-Ons** > **Get Add-Ons**.
46+
Ensure you have all the required products (listed below) installed. If you need to include a product, add it using the Add\-On Explorer. To install an add\-on, go to the **Home** tab and select <img src="Images/image_2.png" width="16" alt="image_2.png"> **Add-Ons** > **Get Add-Ons**.
5247

53-
<a name="H_E850B4FF"></a>
5448

5549
## Products
5650

5751
MATLAB® is used throughout. Tools from Signal Processing Toolbox™ are used frequently as well.
5852

59-
<a name="H_E8C62B23"></a>
60-
6153
# Scripts
62-
63-
*If you are viewing this in a version of MATLAB prior to R2023b, you can view the learning outcomes for each script* [*here*](https://uk.mathworks.com/matlabcentral/fileexchange/171574-introduction-to-digital-signal-processing)
64-
6554
## [**AnalogToDigitalConversion.mlx**](AnalogToDigitalConversion.mlx)
66-
| <img src="Images/image_3.png" width="231" alt="image_3.png"> <br> | **In this script, students will...** <br> <br>- Learn the difference between analog and digital signals <br> <br>- Explore examples of sampling signals at different sample rates <br> <br>- Learn about Nyquist Theorem and why it is important <br> <br>- Work through an example illustrating the effects of sampling and quantization on a short recording of a jazz song <br> |
55+
| | |
6756
| :-- | :-- |
57+
| <img src="Images/image_3.png" width="231" alt="image_3.png"> <br> | **In this script, students will...** <br> $\bullet$ Learn the difference between analog and digital signals <br> $\bullet$ Explore examples of sampling signals at different sample rates <br> $\bullet$ Learn about Nyquist Theorem and why it is important <br> $\bullet$ Work through an example illustrating the effects of sampling and quantization on a short recording of a jazz song <br> |
58+
| | |
6859

6960
## [**FilteringIntro.mlx**](FilteringIntro.mlx)
70-
| <img src="Images/image_4.png" width="231" alt="image_4.png"> <br> | **In this script, students will...** <br> <br>- Learn about the purpose of filtering <br> <br>- Explore a step\-by\-step example of applying a smoothing filter to real\-world accelerometer data <br> <br>- Learn about four different ways of visualizing signals in different domains <br> <br>- Learn about three different types of frequency\-based filters and apply them to a real\-world recording of birds chirping <br> |
61+
| | |
7162
| :-- | :-- |
63+
| <img src="Images/image_4.png" width="231" alt="image_4.png"> <br> | **In this script, students will...** <br> $\bullet$ Learn about the purpose of filtering <br> $\bullet$ Explore a step\-by\-step example of applying a smoothing filter to real\-world accelerometer data <br> $\bullet$ Learn about four different ways of visualizing signals in different domains <br> $\bullet$ Learn about three different types of frequency\-based filters and apply them to a real\-world recording of birds chirping <br> |
64+
| | |
7265

7366
## [**FilterDesign.mlx**](FilterDesign.mlx)
74-
| <img src="Images/image_5.png" width="231" alt="image_5.png"> <br> | **In this script, students will...** <br> <br>- Learn about impulse responses and their importance in designing filters <br> <br>- Learn the difference between FIR and IIR filters and apply them to an audio signal <br> <br>- Explore the importance of group delay and magnitude responses <br> <br>- Use the Design Filter live task to design their own filters <br> |
67+
| | |
7568
| :-- | :-- |
69+
| <img src="Images/image_5.png" width="231" alt="image_5.png"> <br> | **In this script, students will...** <br> $\bullet$ Learn about impulse responses and their importance in designing filters <br> $\bullet$ Learn the difference between FIR and IIR filters and apply them to an audio signal <br> $\bullet$ Explore the importance of group delay and magnitude responses <br> $\bullet$ Use the Design Filter live task to design their own filters <br> |
70+
| | |
7671

7772
## [**BuildFilteringApp.mlx**](BuildFilteringApp.mlx)
78-
| <img src="Images/image_6.png" width="231" alt="image_6.png"> <br> | **In this script, students will...** <br> <br>- Work step by step to build a filtering app <br> |
73+
| | |
7974
| :-- | :-- |
80-
81-
<a name="H_F61733D7"></a>
75+
| <img src="Images/image_6.png" width="231" alt="image_6.png"> <br> | **In this script, students will...** <br> $\bullet$ Work step by step to build a filtering app <br> |
76+
| | |
8277

8378
# License
8479

8580
The license for this module is available in the [LICENSE.md](https://github.com/MathWorks-Teaching-Resources/Introduction-To-Digital-Signal-Processing/blob/release/LICENSE.md).
8681

8782
# Related Courseware Modules
88-
<a name="H_868F5748"></a>
89-
9083
## [Fourier Analysis](https://www.mathworks.com/matlabcentral/fileexchange/106725-fourier-analysis)
91-
| <img src="Images/image_7.png" width="231" alt="image_7.png"> <br> | **Available on:** <br> [<img src="Images/image_8.png" width="91" alt="image_8.png">](https://www.mathworks.com/matlabcentral/fileexchange/106725-fourier-analysis) <br> [<img src="Images/image_9.png" width="136" alt="image_9.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Fourier-Analysis&project=fourier-analysis.prj&file=README.mlx) <br> [GitHub](https://github.com/MathWorks-Teaching-Resources/Fourier-Analysis) <br> |
84+
| | |
9285
| :-- | :-- |
93-
94-
<a name="H_868F5748"></a>
86+
| <img src="Images/image_7.png" width="231" alt="image_7.png"> <br> | **Available on:** <br> [<img src="Images/image_8.png" width="91" alt="image_8.png">](https://www.mathworks.com/matlabcentral/fileexchange/106725-fourier-analysis) <br> [<img src="Images/image_9.png" width="136" alt="image_9.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Fourier-Analysis&project=fourier-analysis.prj&file=README.mlx) <br> [GitHub](https://github.com/MathWorks-Teaching-Resources/Fourier-Analysis) <br> |
87+
| | |
9588

9689
## [Convolution in Digital Signal Processing](https://www.mathworks.com/matlabcentral/fileexchange/97112-convolution-in-digital-signal-processing)
97-
| <img src="Images/image_10.png" width="231" alt="image_10.png"> <br> | **Available on:** <br> [<img src="Images/image_11.png" width="91" alt="image_11.png">](https://www.mathworks.com/matlabcentral/fileexchange/97112-convolution-in-digital-signal-processing) <br> [<img src="Images/image_12.png" width="136" alt="image_12.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Convolution-Digital-Signal-Processing&project=Convolution.prj&file=README.mlx) <br> [GitHub](https://github.com/MathWorks-Teaching-Resources/Convolution-Digital-Signal-Processing) <br> |
90+
| | |
9891
| :-- | :-- |
92+
| <img src="Images/image_10.png" width="231" alt="image_10.png"> <br> | **Available on:** <br> [<img src="Images/image_11.png" width="91" alt="image_11.png">](https://www.mathworks.com/matlabcentral/fileexchange/97112-convolution-in-digital-signal-processing) <br> [<img src="Images/image_12.png" width="136" alt="image_12.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Convolution-Digital-Signal-Processing&project=Convolution.prj&file=README.mlx) <br> [GitHub](https://github.com/MathWorks-Teaching-Resources/Convolution-Digital-Signal-Processing) <br> |
93+
| | |
9994

10095

10196
Or feel free to explore our other [modular courseware content](https://www.mathworks.com/matlabcentral/fileexchange/?q=tag%3A%22courseware+module%22&sort=downloads_desc_30d).
10297

10398
# Educator Resources
10499
- [Educator Page](https://www.mathworks.com/academia/educators.html)
105-
<a name="H_0FA5DA18"></a>
106100

107101
# Contribute
108102

@@ -112,4 +106,3 @@ Looking for more? Find an issue? Have a suggestion? Please contact the [MathWork
112106
*©* Copyright 2024 The MathWorks, Inc
113107

114108

115-

README.mlx

-79 Bytes
Binary file not shown.

SoftwareTests/SmokeTests.m

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ function SmokeRun(testCase,File)
9797

9898
function Path = CheckPreFile(testCase,Filename)
9999
PreFile = "Pre"+replace(Filename,".mlx",".m");
100-
PreFilePath = fullfile(currentProject().RootFolder,"SoftwareTests","PreFiles",PreFile);
101-
if ~isfolder(fullfile(currentProject().RootFolder,"SoftwareTests/PreFiles"))
102-
mkdir(fullfile(currentProject().RootFolder,"SoftwareTests/PreFiles"))
100+
PreFilePath = fullfile(testCase.RootFolder,"SoftwareTests","PreFiles",PreFile);
101+
if ~isfolder(fullfile(testCase.RootFolder,"SoftwareTests/PreFiles"))
102+
mkdir(fullfile(testCase.RootFolder,"SoftwareTests/PreFiles"))
103103
end
104104
if ~isfile(PreFilePath)
105105
writelines("% Pre-run script for "+Filename,PreFilePath)
@@ -113,9 +113,9 @@ function SmokeRun(testCase,File)
113113

114114
function Path = CheckPostFile(testCase,Filename)
115115
PostFile = "Post"+replace(Filename,".mlx",".m");
116-
PostFilePath = fullfile(currentProject().RootFolder,"SoftwareTests","PostFiles",PostFile);
117-
if ~isfolder(fullfile(currentProject().RootFolder,"SoftwareTests/PostFiles"))
118-
mkdir(fullfile(currentProject().RootFolder,"SoftwareTests/PostFiles"))
116+
PostFilePath = fullfile(testCase.RootFolder,"SoftwareTests","PostFiles",PostFile);
117+
if ~isfolder(fullfile(testCase.RootFolder,"SoftwareTests/PostFiles"))
118+
mkdir(fullfile(testCase.RootFolder,"SoftwareTests/PostFiles"))
119119
end
120120
if ~isfile(PostFilePath)
121121
writelines("% Post-run script for "+Filename,PostFilePath)

SoftwareTests/SolnSmokeTests.m

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ function SmokeRun(testCase,File)
112112

113113
function Path = CheckPreFile(testCase,Filename)
114114
PreFile = "Pre"+replace(Filename,".mlx",".m");
115-
PreFilePath = fullfile(currentProject().RootFolder,"SoftwareTests","PreFiles",PreFile);
116-
if ~isfolder(fullfile(currentProject().RootFolder,"SoftwareTests/PreFiles"))
117-
mkdir(fullfile(currentProject().RootFolder,"SoftwareTests/PreFiles"))
115+
PreFilePath = fullfile(testCase.RootFolder,"SoftwareTests","PreFiles",PreFile);
116+
if ~isfolder(fullfile(testCase.RootFolder,"SoftwareTests/PreFiles"))
117+
mkdir(fullfile(testCase.RootFolder,"SoftwareTests/PreFiles"))
118118
end
119119
if ~isfile(PreFilePath)
120120
writelines("% Pre-run script for "+Filename,PreFilePath)
@@ -128,9 +128,9 @@ function SmokeRun(testCase,File)
128128

129129
function Path = CheckPostFile(testCase,Filename)
130130
PostFile = "Post"+replace(Filename,".mlx",".m");
131-
PostFilePath = fullfile(currentProject().RootFolder,"SoftwareTests","PostFiles",PostFile);
132-
if ~isfolder(fullfile(currentProject().RootFolder,"SoftwareTests/PostFiles"))
133-
mkdir(fullfile(currentProject().RootFolder,"SoftwareTests/PostFiles"))
131+
PostFilePath = fullfile(testCase.RootFolder,"SoftwareTests","PostFiles",PostFile);
132+
if ~isfolder(fullfile(testCase.RootFolder,"SoftwareTests/PostFiles"))
133+
mkdir(fullfile(testCase.RootFolder,"SoftwareTests/PostFiles"))
134134
end
135135
if ~isfile(PostFilePath)
136136
writelines("% Post-run script for "+Filename,PostFilePath)

Utilities/ProjectShutdown.m

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,2 @@
1-
function ProjectShutdown
2-
% Reset module to original state that is expected when loading in a new
3-
% MATLAB version.
4-
proj = currentProject;
5-
if isMATLABReleaseOlderThan("R2023b")
6-
cd(proj.RootFolder)
7-
try
8-
if exist(fullfile("Utilities","OldVersions","MainMenuNew.mlx"),"file")
9-
movefile("MainMenu.mlx", fullfile("Utilities","OldVersions","MainMenuOld.mlx"))
10-
movefile(fullfile("Utilities","OldVersions","MainMenuNew.mlx"),fullfile(proj.RootFolder,"MainMenu.mlx"))
11-
end
12-
catch
13-
disp("Failed to move MainMenu.mlx.")
14-
end
15-
try
16-
if exist(fullfile("Utilities","OldVersions","READMENew.mlx"),"file")
17-
movefile("README.mlx", fullfile("Utilities","OldVersions","READMEOld.mlx"))
18-
movefile(fullfile("Utilities","OldVersions","READMENew.mlx"),fullfile(proj.RootFolder,"README.mlx"))
19-
end
20-
catch
21-
disp("Failed to move README.mlx.")
22-
end
23-
end
24-
end
1+
% Close the StartUp app if still open:
2+
delete(findall(groot,'Name','StartUp App'))

Utilities/ProjectStartup.m

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<?xml version='1.0' encoding='UTF-8'?>
1+
<?xml version="1.0" encoding="UTF-8"?>
22
<Info File="Utilities/ProjectShutdown.m" GroupUUID="default" Icon="" Name="ProjectShutdown" Type="Shutdown" Visible="0">
33
<Extension Name="ShutdownPrev" Value="HEAD"/>
44
</Info>

0 commit comments

Comments
 (0)