Documentation error in ps2000aApi.h

Post any questions you may have about our current range of oscilloscopes
Post Reply
markkc
Newbie
Posts: 0
Joined: Sun Jun 18, 2023 8:12 am
Location: Estonia

Documentation error in ps2000aApi.h

Post by markkc »

Posting here as I can't find which Github repo to open an issue on.

There seems to be some inconsistency.
Either the comments for the last two values (AVERAGE/DECIMATE) are switched, or the values are switched.

ps2000aApi.h:

Code: Select all

   662 /// 
   663 /// Various methods of data reduction.
   664 /// Note that a single call to setting the buffers (ie. ps2000aSetDataBuffer) can only
   665 /// associate one buffer with one downsampling mode. If you intend to retrieve more than one
   666 /// downsampling mode from the get values functions, you must call set data buffer several
   667 /// times to associate a separate buffer with each channel and downsampling mode.
   668 /// 
   669 typedef enum enPS2000ARatioMode
   670 {
   671     /// 
   672     /// No downsampling. Returns the raw data values.
   673     /// 
   674     PS2000A_RATIO_MODE_NONE,
   675     /// 
   676     /// Reduces every block of n values to just two values: a minimum and a maximum.
   677     /// The minimum and maximum values are returned in two separate buffers.
   678     /// 
   679     PS2000A_RATIO_MODE_AGGREGATE = 1,
   680     /// 
   681     /// Reduces every block of n values to a single value representing the
   682     /// average (arithmetic mean) of all the values.
   683     /// 
   684     PS2000A_RATIO_MODE_DECIMATE = 2,
   685     /// 
   686     /// Reduces every block of n values to just the first value in the block,
   687     /// discarding all the other values.
   688     /// 
   689     PS2000A_RATIO_MODE_AVERAGE = 4,
   690 } PS2000A_RATIO_MODE;

AndrewA
PICO STAFF
PICO STAFF
Posts: 407
Joined: Tue Oct 21, 2014 3:07 pm

Re: Documentation error in ps2000aApi.h

Post by AndrewA »

Hi,
The enums are correct the comments are incorrect! So this won't affect any code.
I have reported the bug to our development department.
Regards Andrew
Technical Specialist

Post Reply