I am aware that the .NET classes are the result of porting code to .NET. But when will the documentation be decently ported ?
An example:
-------------
public static ComplexDouble[] RealFft( double[] realData
);
Parameters
realData
On input, the real part of the values used to compute the real-valued FFT. On output, the calculated real-valued FFT.
Note The input array is modified by this method. If you need the original data, you must make a copy if it before invoking this method.
Return Value
The calculated real-valued FFT.
-------------
The descroption of the parameter realData (passed by value) makes absolutely no sense untill you realize that , in an earlier life, the method was a routine to do "in-place" FFT transformation.
The description of the overloaded method is even more cryptic:
----------
[C#]
public static ComplexDouble[] RealFft( double[] realData,
bool shiftDC
);
Parameters
realData
The real time-domain signal.
shiftDC
Specifies whether realData is DC-centered. If shiftDC is set to true, realData is DC-centered. If set to false, realData is not DC-centered. The first element of realData is the DC component.
Return Value
The one-dimensional FFT of the time-domain signal.
---------------
I mean if, as stated, realData is the time domain signal and the return value is its FFT, what is then the effect of any additional parameters such as shiftDC ?
And how can "first element of realData", which obviously is the first value of the signal, simultaneously be "the DC component". ?
And the description of the return value: "the one-dimensional FFT" . I mean, is there a multi-dimensional FFT that you can apply to a real-timedomain signal ?
------------------------
A third example: a whole "page" in the documentation of the CoherentGain property of the ScaledWindow class is used to explain the it is "the value of the coherent gain", and you have to "fall back" to the LabView documentation to get any closer to the meaning of the term !!!
-----------------------
My personal experience is that unless you are proficient in "ealier life" (ComponentWorks and/or LabView) you never get neither the overview nor the detailed information necessary to actually use the .Net library for unless your needs are covered by the very few Examples.
Is that on purpose ?
How long is this situation to remain ?
Regards
Morten
