plane_chart.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_PLANE_CHART_H
#define OAKFIELD_PLANE_CHART_H
 
#include "operators/stimulus/coords.h"
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SIM_PLANE_CHART_EPS 1.0e-12
 
typedef enum SimPlaneChartKind {
    SIM_PLANE_CHART_CARTESIAN = 0, 
    SIM_PLANE_CHART_POLAR,         
    SIM_PLANE_CHART_ELLIPTIC,      
    SIM_PLANE_CHART_SPIRAL         
} SimPlaneChartKind;
 
typedef enum SimPlaneProjectionKind {
    SIM_PLANE_PROJECTION_FULL = 0, 
    SIM_PLANE_PROJECTION_PRIMARY,  
    SIM_PLANE_PROJECTION_SECONDARY 
} SimPlaneProjectionKind;
 
typedef enum SimPlaneChartWrapPolicy {
    SIM_PLANE_CHART_WRAP_NONE = 0,       
    SIM_PLANE_CHART_WRAP_SIGNED_ANGLE,   
    SIM_PLANE_CHART_WRAP_UNSIGNED_ANGLE, 
    SIM_PLANE_CHART_WRAP_UNIT_INTERVAL   
} SimPlaneChartWrapPolicy;
 
typedef enum SimPlaneChartStatus {
    SIM_PLANE_CHART_STATUS_OK = 0,           
    SIM_PLANE_CHART_STATUS_INVALID_ARGUMENT, 
    SIM_PLANE_CHART_STATUS_UNSUPPORTED,      
    SIM_PLANE_CHART_STATUS_OUT_OF_DOMAIN,    
    SIM_PLANE_CHART_STATUS_SINGULAR,         
    SIM_PLANE_CHART_STATUS_NON_INVERTIBLE,   
    SIM_PLANE_CHART_STATUS_NUMERIC_FAILURE   
} SimPlaneChartStatus;
 
enum {
    SIM_PLANE_CHART_SEMANTIC_NONE = 0u,
    SIM_PLANE_CHART_SEMANTIC_PERIODIC_SECONDARY = 1u << 0,
    SIM_PLANE_CHART_SEMANTIC_SINGULAR_CENTER = 1u << 1,
    SIM_PLANE_CHART_SEMANTIC_SECONDARY_BRANCH_CUT = 1u << 2
};
 
enum { SIM_PLANE_CHART_CAPABILITY_NONE = 0u };
 
typedef struct SimPlaneSamplingFrame {
    double origin_x;   
    double origin_y;   
    double spacing_x;  
    double spacing_y;  
    double center_x;   
    double center_y;   
    double velocity_x; 
    double velocity_y; 
} SimPlaneSamplingFrame;
 
typedef struct SimPlaneChartConfig {
    SimPlaneChartKind kind;                 
    SimPlaneChartWrapPolicy secondary_wrap; 
    double rotation;                        
    double ellipse_u;                       
    double ellipse_v;                       
    double spiral_arms;                     
    double spiral_pitch;                    
    double spiral_phase;                    
    double spiral_angular_velocity;         
} SimPlaneChartConfig;
 
typedef struct SimPlaneProjectionConfig {
    SimPlaneProjectionKind kind; 
} SimPlaneProjectionConfig;
 
typedef struct SimPlaneChartCoord {
    double primary;   
    double secondary; 
} SimPlaneChartCoord;
 
typedef struct SimPlaneProjectionValue {
    double primary;     
    double secondary;   
    bool has_secondary; 
} SimPlaneProjectionValue;
 
const char *sim_plane_chart_status_string(SimPlaneChartStatus status);
 
void sim_plane_sampling_frame_normalize(SimPlaneSamplingFrame *frame);
 
void sim_plane_chart_normalize(SimPlaneChartConfig *chart);
 
void sim_plane_projection_normalize(SimPlaneProjectionConfig *projection);
 
unsigned int sim_plane_chart_semantic_flags(const SimPlaneChartConfig *chart);
 
unsigned int sim_plane_chart_capability_flags(const SimPlaneChartConfig *chart);
 
SimPlaneChartStatus sim_plane_chart_eval(const SimPlaneSamplingFrame *frame,
                                         const SimPlaneChartConfig *chart, double x, double y,
                                         double t, SimPlaneChartCoord *out_coord);
 
SimPlaneChartStatus sim_plane_projection_eval(const SimPlaneProjectionConfig *projection,
                                              SimPlaneChartCoord coord,
                                              SimPlaneProjectionValue *out_value);
 
SimPlaneChartStatus sim_plane_chart_eval_projected(const SimPlaneSamplingFrame *frame,
                                                   const SimPlaneChartConfig *chart,
                                                   const SimPlaneProjectionConfig *projection,
                                                   double x, double y, double t,
                                                   SimPlaneProjectionValue *out_value);
 
SimPlaneChartStatus sim_plane_chart_from_stimulus_coord(const SimStimulusCoordConfig *coord,
                                                        SimPlaneSamplingFrame *out_frame,
                                                        SimPlaneChartConfig *out_chart,
                                                        SimPlaneProjectionConfig *out_projection);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_PLANE_CHART_H */