Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Ringz.schelp #1508

Merged
merged 1 commit into from
May 29, 2015
Merged

Update Ringz.schelp #1508

merged 1 commit into from
May 29, 2015

Conversation

porres
Copy link
Contributor

@porres porres commented May 29, 2015

I made this change because the help file, as it was originally written, did really throw me off by believe that both Resonz and Ringz were in fact the exact same filter, being the only exception how you set the filter parameters. I added more information regarding the relationship between Resonz and Ringz so the differences and similirarities between them is made clearer.

The help file of Resonz should also be updated to also state the relatioship between these two objects. It doesn't make sense to make the relationship in this help file but completely omit it in the other one. So I'm also going to propose some changes in the help file of Resonz to make it like this one.

I made this change because the help file, as it was originally written, did really throw me off by believe that both Resonz and Ringz were in fact the exact same filter, being the only exception how you set the filter parameters. I added more information regarding the relationship between Resonz and Ringz so the differences and similirarities between them is made clearer. 

The help file of Resonz should also be updated to also state the relatioship between these two objects. It doesn't make sense to make the relationship in this help file but completely omit it in the other one. So I'm also going to propose some changes in the help file of Resonz to make it like this one.
telephon added a commit that referenced this pull request May 29, 2015
help: explain the difference between Resonz and Ringz
@telephon telephon merged commit c182eb1 into supercollider:master May 29, 2015
This is the same as link::Classes/Resonz:: , except that instead of a
resonance parameter, the bandwidth is specified in a 60dB ring decay
time. One Ringz is equivalent to one component of the
This is the same as link::Classes/Resonz:: , except that it is constant skirt gain filter, meaning that the peak gain depends on the value of Q. Also, instead of the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whereas Resonz is a ___ ?

its great that you are adding more detail, but its leaving an unanswered question. if Resonz and Ringz are fundamentally different, then how are they different ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a suggestion to change the Resonz help file #1509

Resonz is a constant 0 dB gain filter, Ringz is constant skirt, this is the fundamental difference between the two. Other than that, they're the same. In practice, when you change the resonance parameter in Rignz, it'll add more gain to the filter, whereas in Resonz the peak gain will remain at 0 dB.

Anyway, like I said, I made the changes in Resonz so this is clearer. The way it was before wasnt clear and was actually misleading. It also didn't make sense to me not making the relationship between both of them in the help file of Resonz.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants