class library: plot relative to target synth #3088

telephon · 2017-08-01T16:33:28Z

Sometimes, one needs to plot values from a synth that depends on node
order. E.g. a synth that reads from a bus. This patch allows us to
determine the point at which the plotting synth is inserted in the node
order. It is inserted after the target node. By default, this is the
default group of the default server. This follows the asTarget
interface, as documented in scdoc.

Sometimes, one needs to plot values from a synth that depends on node order. E.g. a synth that reads from a bus. This patch allows us to determine the point at which the plotting synth is inserted in the node order. It is inserted _after_ the target node. By default, this is the default group of the default server. This follows the `asTarget` interface, as documented in scdoc.

joshpar · 2017-08-01T16:35:44Z

This is great. I wonder if scope should have something similar? /* Josh Parmenter www.realizedsound.net/josh */

…

On Aug 1, 2017, at 09:33, Julian Rohrhuber ***@***.***> wrote: Sometimes, one needs to plot values from a synth that depends on node order. E.g. a synth that reads from a bus. This patch allows us to determine the point at which the plotting synth is inserted in the node order. It is inserted after the target node. By default, this is the default group of the default server. This follows the asTarget interface, as documented in scdoc. You can view, comment on, or merge this pull request online at: #3088 Commit Summary class library: plot relative to target synth File Changes M HelpSource/Classes/Function.schelp (17) M SCClassLibrary/Common/Core/Function.sc (10) Patch Links: https://github.com/supercollider/supercollider/pull/3088.patch https://github.com/supercollider/supercollider/pull/3088.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

telephon · 2017-08-01T17:18:05Z

Ah definitely. I don't have the time now, but it should be easy.

Also, I'd love to have a node-based server meter that lets you see all the signals of all the nodes and busses. But that's for later :)

telephon · 2017-08-01T17:19:33Z

(for scope, it is in BusScopeSynth::play).

adcxyz · 2017-08-05T17:46:59Z

really nice, thanks!

Also, I'd love to have a node-based server meter that lets you see all the signals of all the nodes and busses. But that's for later :)

Maybe ProxyMeter (in JITLibExtensions) could be extended/adapted easily for this ?

mossheim · 2017-08-06T15:01:27Z

HelpSource/Classes/Function.schelp

 argument::duration
 The duration of the function to plot in seconds. The default is 0.01.
 argument::server
-The Server on which to calculate the plot. This must be running on your local machine, but does not need to be the internal server. If nil the default server will be used.
+The Server on which to calculate the plot. This must be running on your local machine, but does not need to be the internal server. If nil the default server will be used. This argument can also be a group or synth, it then is used as a target (see link::Reference/asTarget::):


can this argument name also change to target?

if we all agree yes, please. I just tried not to change the interface.

This will make the current PR an API change. Do we want this? We could also do this change later, and have this one in 3.9.

I vote for change to argument: target

it expresses the power and flexibility of the method very clearly
1.a by comparison, the arg 'server' makes it confusing that it can also be any target,
and makes it necessary to explain in the help file - which may not be seen often.

Function.plot is a utility for checking what the signal resulting from a short synthesis snippet looks like; my guess is that in >99% of the cases it will run silently on the default server, and in >99% of those uses no one specifies a server by keyword.
Building any larger projects by relying on code like
~myplotter = { ... }.plot(server: ~mySpecialServer);
seems really unlikely, and would IMHO not be advisable style.

2c adc

This applies to the methods: - Function:plot - Function: loadToFloatArray - Function:asBuffer

muellmusik

Generally I like the idea. A few comments.

muellmusik · 2017-10-03T18:25:21Z

HelpSource/Classes/Function.schelp

-argument::server
-The Server on which to calculate the plot. This must be running on your local machine, but does not need to be the internal server. If nil the default server will be used.
+argument::target
+The target node on which to calculate the plot. See link::Reference/asTarget::. If it is a link::Classes/Server::, it must be running on your local machine, but does not need to be the internal server (see link::Classes/Buffer#-loadToFloatArray:: for details).


Does the implementation really require a local server? Why? getToFloatArray should work or?

Also, it would be useful to explain what's happening (addAfter) with target and why. With Function:plot presumably target only matters if you are reading from a bus. I find 'on which to calculate the plot' a bit enigmatic for newbies.

It uses loadToFloatArray, presumably for speed. In general, the class library seems to avoid getToFloatArray; I'm not sure why.

For the default 100ms plot duration, get... rather than load... will not be any slower -- might even be faster. For longer plots, load... is much faster.

I think getToFloatArray was added later, and everyone, including me, is copying the old one.

IAC plotting on remote servers seems desirable.

Also, I think the getToFloatArray looks more complicated and insecure with the wait and timeout arguments. Also the argument names index and count don't match the ones of loadToFloatArray.

That might be the reason. Maybe we need the same thing as we have for SynthDef, something that tries to send first and if that fails, tries to load? All packed under a clean interface.

muellmusik · 2017-10-03T18:30:45Z

HelpSource/Classes/Function.schelp

 argument::bounds
 An instance of Rect or Point indicating the bounds of the plot window.
 argument::minval
 the minimum value in the plot. Defaults to -1.0.
 argument::maxval
 the maximum value in the plot. Defaults to 1.0.
 argument:: separately
-For multi channel signals, set whether to use separate value display ranges or not.
-a window to place the plot in. If nil, one will be created for you.
+If set to code::true::, for multichannel signals use separate value display ranges.


How are these specified?

telephon · 2017-10-04T17:27:07Z

OK, here are some improvements - thanks for your ideas!

This code has been factored out of loadToFloatArray.

telephon · 2017-11-02T14:30:05Z

ping

adcxyz

little glitch: in Function.schelp lines 455 and 457, minimum and maximum are swapped between argument names and description lines. everything else looks good!

mossheim · 2018-02-04T20:47:48Z

SCClassLibrary/Common/GUI/PlusGUI/Math/PlotView.sc

@@ -769,14 +769,13 @@ Plotter {


 + Function {
-	plot { |duration = 0.01, server, bounds, minval, maxval, separately = false|
-
+	plot { |duration = 0.01, target, bounds, minval, maxval, separately = false|


changing function parameter names is a breaking change...

mossheim · 2018-02-04T20:48:00Z

SCClassLibrary/Common/Core/Function.sc

@@ -311,15 +313,24 @@ Function : AbstractFunction {
 		^buffer
 	}

-	loadToFloatArray { |duration = 0.01, server, action|
-		this.asBuffer(duration, server, { |buffer|
+	loadToFloatArray { |duration = 0.01, target, action|


same here, breaking change

mossheim · 2018-02-04T20:48:07Z

SCClassLibrary/Common/Core/Function.sc

-	asBuffer { |duration = 0.01, server, action, fadeTime = (0)|
-		var buffer, def, synth, name, numChannels, rate;
-		server = server ? Server.default;
+	asBuffer { |duration = 0.01, target, action, fadeTime = (0)|


also breaking change

mossheim · 2018-02-04T20:48:54Z

I would like to see this go through, but I think the general policy we've been following is not to change parameter names of methods because it potentially breaks user code. I don't know what to do in this case, because it makes semantic sense to change it.

telephon · 2018-02-04T20:57:35Z

I'd suggest the following: for now, I don't change the names, but when we make the next version step from 3.9 to 3.10, we do the breaking change. I could open an issue with that milestone, so we don't forget.

We could use that as an occasion to fix as many similar cases as possible.

mossheim · 2018-02-04T21:02:27Z

I'd suggest the following: for now, I don't change the names, but when we make the next version step from 3.9 to 3.10, we do the breaking change.

This is already milestoned as 3.10... should it not be?

We could use that as an occasion to fix as many similar cases as possible.

If the policy is that we can always make breaking changes in a minor release, I don't see why we would need (or want) to group them.

telephon · 2018-02-04T21:14:17Z

In the past, such smaller breaking changes have often happened in minor releases. The major releases (sc1, sc2, sc3) were different: they basically broke everything.

If we want to change this, we need to speed up with major releases, otherwise we get stuck.

telephon · 2018-02-18T19:12:14Z

what should we do? Merge it to develop as it is now?

telephon · 2018-02-23T11:10:28Z

Is that ok to go into develop?

nhthn · 2018-07-13T09:11:49Z

i'm a little dissatisfied with this loadToFloatArray/getToFloatArray API, one only working for local servers and one working for all servers but unreliably. i don't really dig the names either, the differences between them is not obvious.

would it make sense for Function:plot to call loadToFloatArray if the server is local and getToFloatArray if the server is remote?

if that's the case, could the get/load dichotomy be abstracted in the Buffer class? and also, let's take this opportunity to rename these methods so it's easier to tell what they're doing.

Buffer:getContentsWithSoundFile uses b_write.
Buffer:getContentsOverOSC uses repeated calls to /b_getn.
Buffer:getContents, which calls Buffer:getContentsWithSoundFile if the server is local and Buffer:getContentsOverOSC otherwise

so just by calling Buffer:getContents, the best retrieval method is selected for you.

telephon · 2018-07-13T10:07:44Z

@snappizz could you please open a new issue for that? I agree that the names are not so good, but they have been around for decades and this is something separate from the current glitch that needs to be fixed.

telephon · 2018-07-13T10:08:54Z

would it make sense for Function:plot to call loadToFloatArray if the server is local and getToFloatArray if the server is remote?

possible. As a first step, getToFloatArray should work in plot, then I'd try and abstract this out.

mossheim added comp: class library SC class library comp: Qt GUI sclang Qt components -- for IDE tickets, use "env: SCIDE" instead labels Aug 2, 2017

adcxyz requested review from adcxyz and removed request for adcxyz August 5, 2017 17:47

mossheim reviewed Aug 6, 2017

View reviewed changes

class library: rename server to target in plot methods

c86f706

This applies to the methods: - Function:plot - Function: loadToFloatArray - Function:asBuffer

nhthn changed the base branch from master to develop September 24, 2017 07:13

telephon requested a review from muellmusik October 2, 2017 18:03

muellmusik reviewed Oct 3, 2017

View reviewed changes

telephon added 4 commits October 4, 2017 19:18

class library: use getToFloatArray in function plot

c070baa

help: no local server restriction for function plot

7a61b64

help: correct description of plot parameters

b65aa0b

help: improve wording of target argument for plot

22247f2

telephon mentioned this pull request Oct 5, 2017

Add RunningSum2 UGen with Help file. #3198

Closed

telephon added 3 commits October 11, 2017 08:46

class library: correct error message

2d5f1e8

This code has been factored out of loadToFloatArray.

help: improve code formatting

471f411

help: document factored out function methods

24cf38f

adcxyz requested changes Nov 2, 2017

View reviewed changes

help: fix max min typo

52c7ff5

adcxyz approved these changes Nov 8, 2017

View reviewed changes

mossheim added this to the 3.10 milestone Feb 4, 2018

mossheim reviewed Feb 4, 2018

View reviewed changes

telephon added the API change label Feb 23, 2018

telephon merged commit eabd21d into supercollider:develop May 12, 2018

nhthn mentioned this pull request Jul 13, 2018

FAILURE IN SERVER /b_getn index out of range #3873

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

class library: plot relative to target synth #3088

class library: plot relative to target synth #3088

telephon commented Aug 1, 2017

joshpar commented Aug 1, 2017 via email

telephon commented Aug 1, 2017

telephon commented Aug 1, 2017

adcxyz commented Aug 5, 2017

mossheim Aug 6, 2017

telephon Aug 8, 2017

telephon Sep 20, 2017

adcxyz Sep 20, 2017 •

edited

muellmusik left a comment

muellmusik Oct 3, 2017

jamshark70 Oct 4, 2017

telephon Oct 4, 2017 •

edited

muellmusik Oct 4, 2017

telephon Oct 4, 2017 •

edited

muellmusik Oct 3, 2017

telephon commented Oct 4, 2017

telephon commented Nov 2, 2017

adcxyz left a comment •

edited

mossheim Feb 4, 2018

mossheim Feb 4, 2018

mossheim Feb 4, 2018

mossheim commented Feb 4, 2018 •

edited

telephon commented Feb 4, 2018

mossheim commented Feb 4, 2018

telephon commented Feb 4, 2018

telephon commented Feb 18, 2018

telephon commented Feb 23, 2018

nhthn commented Jul 13, 2018

telephon commented Jul 13, 2018

telephon commented Jul 13, 2018

class library: plot relative to target synth #3088

class library: plot relative to target synth #3088

Conversation

telephon commented Aug 1, 2017

joshpar commented Aug 1, 2017 via email

telephon commented Aug 1, 2017

telephon commented Aug 1, 2017

adcxyz commented Aug 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adcxyz Sep 20, 2017 • edited

Choose a reason for hiding this comment

muellmusik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

telephon Oct 4, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

telephon Oct 4, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

telephon commented Oct 4, 2017

telephon commented Nov 2, 2017

adcxyz left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mossheim commented Feb 4, 2018 • edited

telephon commented Feb 4, 2018

mossheim commented Feb 4, 2018

telephon commented Feb 4, 2018

telephon commented Feb 18, 2018

telephon commented Feb 23, 2018

nhthn commented Jul 13, 2018

telephon commented Jul 13, 2018

telephon commented Jul 13, 2018

adcxyz Sep 20, 2017 •

edited

telephon Oct 4, 2017 •

edited

telephon Oct 4, 2017 •

edited

adcxyz left a comment •

edited

mossheim commented Feb 4, 2018 •

edited