Function getDirectionalEllipse

getDirectionalEllipse(points?: DataXY<DoubleArray>, options??: {
    nbSD?: number;
}): {
    majorAxis: {
        point1: {
            x: number;
            y: number;
        };
        point2: {
            x: number;
            y: number;
        };
    };
    minorAxis: {
        point1: {
            x: number;
            y: number;
        };
        point2: {
            x: number;
            y: number;
        };
    };
    position: {
        x: number;
        y: number;
    };
    rMajor: number;
    rMinor: number;
}
Calculates the Directional Ellipse for a set of points with a specific standard deviation
Parameters
- Optional points: DataXY<DoubleArray>
  
  variable points is of type DataXY, points.x contains the x coordinates of the points, points.y contains the y coordinates of the points
- Optional options: {
  nbSD?: number;
  } = {}
  - Optional nbSD?: number
    
    Number of standard deviations
    
    Default
    2
Returns {
    majorAxis: {
        point1: {
            x: number;
            y: number;
        };
        point2: {
            x: number;
            y: number;
        };
    };
    minorAxis: {
        point1: {
            x: number;
            y: number;
        };
        point2: {
            x: number;
            y: number;
        };
    };
    position: {
        x: number;
        y: number;
    };
    rMajor: number;
    rMinor: number;
}
- majorAxis: {
      point1: {
          x: number;
          y: number;
      };
      point2: {
          x: number;
          y: number;
      };
  }
  - point1: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  - point2: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
- minorAxis: {
      point1: {
          x: number;
          y: number;
      };
      point2: {
          x: number;
          y: number;
      };
  }
  - point1: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  - point2: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
- position: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- rMajor: number
- rMinor: number
- Defined in index.ts:11

Function getDirectionalEllipse

Parameters

`Optional` points: DataXY<DoubleArray>

`Optional` options: {
nbSD?: number;
} = {}

`Optional` nbSD?: number

Default

majorAxis: {
    point1: {
        x: number;
        y: number;
    };
    point2: {
        x: number;
        y: number;
    };
}

point1: {
x: number;
y: number;
}

x: number

y: number

point2: {
x: number;
y: number;
}

x: number

y: number

minorAxis: {
    point1: {
        x: number;
        y: number;
    };
    point2: {
        x: number;
        y: number;
    };
}

point1: {
x: number;
y: number;
}

x: number

y: number

point2: {
x: number;
y: number;
}

x: number

y: number

position: {
x: number;
y: number;
}

x: number

y: number

rMajor: number

rMinor: number

Settings

Member Visibility

Theme

Function getDirectionalEllipse

Parameters

Optional points: DataXY<DoubleArray>

Optional options: { nbSD?: number; } = {}

Optional nbSD?: number

Default

Returns { majorAxis: { point1: { x: number; y: number; }; point2: { x: number; y: number; }; }; minorAxis: { point1: { x: number; y: number; }; point2: { x: number; y: number; }; }; position: { x: number; y: number; }; rMajor: number; rMinor: number; }

majorAxis: { point1: { x: number; y: number; }; point2: { x: number; y: number; }; }

point1: { x: number; y: number; }

x: number

y: number

point2: { x: number; y: number; }

x: number

y: number

minorAxis: { point1: { x: number; y: number; }; point2: { x: number; y: number; }; }

point1: { x: number; y: number; }

x: number

y: number

point2: { x: number; y: number; }

x: number

y: number

position: { x: number; y: number; }

x: number

y: number

rMajor: number

rMinor: number

Settings

Member Visibility

Theme

`Optional` points: DataXY<DoubleArray>

`Optional` options: {
nbSD?: number;
} = {}

`Optional` nbSD?: number

Returns {
majorAxis: {
point1: {
x: number;
y: number;
};
point2: {
x: number;
y: number;
};
};
minorAxis: {
point1: {
x: number;
y: number;
};
point2: {
x: number;
y: number;
};
};
position: {
x: number;
y: number;
};
rMajor: number;
rMinor: number;
}

majorAxis: {
point1: {
x: number;
y: number;
};
point2: {
x: number;
y: number;
};
}

point1: {
x: number;
y: number;
}

point2: {
x: number;
y: number;
}

minorAxis: {
point1: {
x: number;
y: number;
};
point2: {
x: number;
y: number;
};
}

point1: {
x: number;
y: number;
}

point2: {
x: number;
y: number;
}

position: {
x: number;
y: number;
}