das2/plane.h File Reference

Header for Plane Descriptor Objects. More...


Detailed Description

Header for Plane Descriptor Objects.

#include <stdbool.h>
#include <das2/buffer.h>
#include <das2/descriptor.h>
#include <das2/units.h>
#include <das2/encoding.h>

Go to the source code of this file.

Data Structures

struct  PlaneDesc
 Describes a data plane within a packet type. More...

Enumerations

enum  plane_type_t
 

An enumeration of packet data plane types.

More...

Functions

plane_type_t str2PlaneType (const char *type)
 Returns the enumeration for the data type string.
const char * PlaneType_toString (plane_type_t type)
 Returns the string for the enumeration.

Enumeration Type Documentation

An enumeration of packet data plane types.

A Das2 packet contains one dependent value set from each of it's Planes. The plane types are:

X - Data defined within an <x> plane, typically these are time values. There is one value for each X plane in a Das2 data packet

Y - Data defined within a <y> plane, this would be line-plot data. There is one value for each Y plane in a Das2 data packet. This value is correlated with the <x> plane value in the packet.

Z - Data defined within a <z> plane. There is one value for each Z plane in a Das2 data packet. The Z value is correlated with both the <x> plane value and the <y> plane value.

YScan - Our most common data type, values are defined by a <yscan> plain tag. There are 1-N values in each YScan plane for each das2 data packet. All YScan values from a single data packet are correlated with the X value provide in the <x> plane.

 All Data Structures Files Functions Variables Typedefs Enumerations Defines

Generated on 11 Sep 2016 for Das2 Stream Utilities by  doxygen 1.6.1